Website for the Eclipse Hawk project

Clone this repo:

Branches

  1. b60c861 Update website by Antonio García-Domínguez · 4 months ago master
  2. 65c108a Mention the Docker images for Hawk by Antonio García-Domínguez · 4 months ago
  3. 549d5d5 Rebuild website by Antonio García-Domínguez · 8 months ago
  4. 0051a77 Fix broken URLs to assets by Antonio García-Domínguez · 8 months ago
  5. c512318 Rebuild site by Antonio García-Domínguez · 8 months ago

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.