Fix broken URLs to assets
1 file changed
tree: b23c2d3fdb74e1c1a021a19cb70d0845030796d5
  1. 404.html
  2. README.md
  3. additional-resources/
  4. advanced-use/
  5. assets/
  6. basic-use/
  7. developers/
  8. index.html
  9. mkdocs/
  10. search/
  11. server/
  12. sitemap.xml
  13. sitemap.xml.gz
  14. stylesheets/
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.