Add info on setting the site locally
This commit is contained in:
parent
bb6e545354
commit
04300d300b
1 changed files with 19 additions and 6 deletions
25
README.md
25
README.md
|
@ -29,28 +29,41 @@ defined in [`.gitlab-ci.yml`](.gitlab-ci.yml):
|
|||
```yaml
|
||||
image: elecnix/ikiwiki
|
||||
|
||||
before_script:
|
||||
- apt-get install -y git
|
||||
- git submodule init
|
||||
- git submodule update
|
||||
|
||||
test:
|
||||
stage: test
|
||||
script: ikiwiki --setup .ikiwiki/ikiwiki.setup
|
||||
except:
|
||||
- master
|
||||
script:
|
||||
- ikiwiki --setup .ikiwiki/ikiwiki.setup --libdir themes/ikistrap/lib
|
||||
only:
|
||||
- branches
|
||||
- tags
|
||||
|
||||
pages:
|
||||
stage: deploy
|
||||
script: ikiwiki --setup .ikiwiki/ikiwiki.setup
|
||||
script:
|
||||
- ikiwiki --setup .ikiwiki/ikiwiki.setup --libdir themes/ikistrap/lib
|
||||
artifacts:
|
||||
paths:
|
||||
- public
|
||||
only:
|
||||
- master
|
||||
```
|
||||
|
||||
We are using a theme based on Bootstrap 4 using submodules, and in order to
|
||||
enable the theme plugin, we must pass the `libdir` parameter.
|
||||
|
||||
## Building locally
|
||||
|
||||
To work locally with this project, you'll have to follow the steps below:
|
||||
|
||||
1. Fork, clone or download this project
|
||||
1. [Install][] ikiwiki
|
||||
1. Generate the website: `ikiwiki --setup .ikiwiki/ikiwiki.setup`
|
||||
1. Clone the submodules: `git submodule init && git submodule update`
|
||||
1. Generate the website: `ikiwiki --setup .ikiwiki/ikiwiki.setup --libdir themes/ikistrap/lib`
|
||||
1. Preview your project: open `public/index.html` in a browser
|
||||
|
||||
Read more at ikiwiki's [documentation][].
|
||||
|
@ -83,4 +96,4 @@ unless you want to contribute back to the upstream project.
|
|||
[install]: https://ikiwiki.info/install/
|
||||
[documentation]: https://ikiwiki.info/
|
||||
[userpages]: http://doc.gitlab.com/ee/pages/README.html#user-or-group-pages
|
||||
[projpages]: http://doc.gitlab.com/ee/pages/README.html#project-pages
|
||||
[projpages]: http://doc.gitlab.com/ee/pages/README.html#project-pages
|
||||
|
|
Loading…
Reference in a new issue