commit | ed11ad42da529927b463217b1f30b18420cc24e5 | [log] [tgz] |
---|---|---|
author | Antonio García-Domínguez <agarcdomi@gmail.com> | Tue Dec 01 10:48:58 2020 +0000 |
committer | Antonio García-Domínguez <agarcdomi@gmail.com> | Tue Dec 01 10:48:58 2020 +0000 |
tree | e1377bedc0102a8b5db5aee3c3f924342ec95196 | |
parent | ffc6b4a7dbb04495e8ccd68857cf6106b2d70fec [diff] |
Build site
This repository hosts the MkDocs source code for the Eclipse Hawk website.
To work on the website, go into the mkdocs
folder and set up a Python 3 virtualenv environment and install the dependencies through pip
:
virtualenv -p python3 env pip install -r requirements.txt
The virtualenv
environment will remain active until you terminate that console session. If you want to continue working on the website, you will need to reactivate the environment with:
source env/bin/activate
Once the virtualenv
environment is activated and the project dependencies have been installed, you can start the built-in development server with:
mkdocs serve
The website has a number of useful Markdown extensions enabled:
After a new version of the website is ready and before you push, make sure you build it with the build.sh
script inside mkdocs
.