From 04300d300b928f999ecb6d809d7c6d1b71603413 Mon Sep 17 00:00:00 2001 From: Achilleas Pipinellis Date: Thu, 7 Jul 2016 11:17:30 +0300 Subject: [PATCH] Add info on setting the site locally --- README.md | 25 +++++++++++++++++++------ 1 file changed, 19 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index d8bce20..9c2c4d7 100644 --- a/README.md +++ b/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 \ No newline at end of file +[projpages]: http://doc.gitlab.com/ee/pages/README.html#project-pages