This is the repository for the old version of Thelia documentation, it will not be maintened anymore please see http://thelia/docs for the new version.
Our documentation is made using Jekyll (http://jekyllrb.com/)
In order to contribute please install the following :
Run Jekyll server (on port 4000) Inside your directory (ex: ~/dev/thelia.github.io/)
$ npm install
$ bower install
$ grunt
$ jekyll serve --watch
To see the result : http://localhost:4000
In order to let the documentation be aware of your new page please fill in the file
_config.yml
And reload Jekyll server
In addition, this documentation layout use Bootstrap and this LESS files for CSS.
You can run github-pages in a container, just run docker.sh script. With that you don't have to install github-pages on your machine.
A single directory represents one language. By convention, the name of the directory must correspond to ISO 639-1 code.
For each language, you must define : name (English), code (en), url (/en) and sidebar. To define this elements, you must edit the _config.yml file to add your language configuration like this :
languages:
- {
name: "English", code: "en", url: "/", sidebar:
...
}
- {
name: "Your language", code: "ISO 639-1 code", url: "/url-to-language", sidebar:
...
}The best way is to duplicate English configuration which is the most advanced. So you can duplicate english directory (en) and rename it with the correct language code.
After updated the _config.yml file, you have to restart your Jekyll server.
first install Sami and its dependencies :
composer installYou need to have a clone of the Thelia locally. for instance : ~/thelia
git clone ~/theliaenv THELIA_PATH='~/thelia' php vendor/sami/sami/sami.php update api.phpTake a coffee break...
Bootstrap is under MIT licence.