commit | 1352c2b12ac9e34a39007abc72e5b19263d23261 | [log] [tgz] |
---|---|---|
author | Antonio García-Domínguez <agarcdomi@gmail.com> | Wed Oct 23 11:19:27 2019 +0100 |
committer | Antonio García-Domínguez <agarcdomi@gmail.com> | Wed Oct 23 11:19:27 2019 +0100 |
tree | 798a8ca1b88b7f3403e6c98121bd1231ad024eef | |
parent | 3efbfd6982889b449ecd5e08aef9693f0f42663c [diff] |
Add link for filing a bug
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
.