commit | d51b89d91e5c4cf55ddeb88525526e981eb3685d | [log] [tgz] |
---|---|---|
author | Antonio García-Domínguez <agarcdomi@gmail.com> | Tue Oct 08 14:16:14 2019 +0100 |
committer | Antonio García-Domínguez <agarcdomi@gmail.com> | Tue Oct 08 14:16:14 2019 +0100 |
tree | aad13c5a66fbb771a6e80264b4192962b7e3a1c5 | |
parent | 1c171e91c22036efd20739bda5a70f9f230d8ccc [diff] |
Add instructions for working on website
This repository hosts the MkDocs source code for the Eclipse Hawk website.
To work on the website, 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:
mkdocs build
The repository has an .htaccess
file which will silently redirect all requests to go through the site
subfolder produced by MkDocs.