Add 'search' plugin back
1 file changed
tree: 3ab2abaea8bc7bb82257852c77fa4d24e272edee
  1. additional-resources/
  2. advanced-use/
  3. assets/
  4. basic-use/
  5. developers/
  6. mkdocs/
  7. server/
  8. stylesheets/
  9. 404.html
  10. index.html
  11. README.md
  12. sitemap.xml
  13. sitemap.xml.gz
README.md

Hawk website

This repository hosts the MkDocs source code for the Eclipse Hawk website.

Development

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

Available extensions

The website has a number of useful Markdown extensions enabled:

Deployment

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.