commit | 916028a2e3fc4c69090515791b901c39ddad28cf | [log] [tgz] |
---|---|---|
author | Antonio García-Domínguez <agarcdomi@gmail.com> | Fri May 08 15:32:21 2020 +0100 |
committer | Antonio García-Domínguez <agarcdomi@gmail.com> | Fri May 08 15:32:21 2020 +0100 |
tree | a56ed0ffcfa88753e9d108e9b5b9f28dff14c0c6 | |
parent | 328718fae1d9464caec38234ae5cc530fe5ff387 [diff] |
Mention server-only update site here
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
.