forge/ayakael.net
1
0
Fork 0
Code Issues 14 Pull requests Projects Releases Packages Wiki Activity Actions

Add info on setting the site locally

Browse source
This commit is contained in:
Achilleas Pipinellis 2016-07-07 11:17:30 +03:00
parent bb6e545354
commit 04300d300b
1 changed files with 19 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -29,28 +29,41 @@ defined in [`.gitlab-ci.yml`](.gitlab-ci.yml):
```yaml ```yaml
image: elecnix/ikiwiki image: elecnix/ikiwiki
before_script:
- apt-get install -y git
- git submodule init
- git submodule update
test: test:
stage: test stage: test
script: ikiwiki --setup .ikiwiki/ikiwiki.setup script:
except: - ikiwiki --setup .ikiwiki/ikiwiki.setup --libdir themes/ikistrap/lib
- master only:
- branches
- tags
pages: pages:
stage: deploy stage: deploy
script: ikiwiki --setup .ikiwiki/ikiwiki.setup script:
- ikiwiki --setup .ikiwiki/ikiwiki.setup --libdir themes/ikistrap/lib
artifacts: artifacts:
paths: paths:
- public - public
only: only:
- master - 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 ## Building locally
To work locally with this project, you'll have to follow the steps below: To work locally with this project, you'll have to follow the steps below:
1. Fork, clone or download this project 1. Fork, clone or download this project
1. [Install][] ikiwiki 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 1. Preview your project: open `public/index.html` in a browser
Read more at ikiwiki's [documentation][]. Read more at ikiwiki's [documentation][].