Installation

1. Clone Project

Clone the official Highlight repo into a clean project folder or use the Template feature on Github.

git clone https://github.com/annedorko/highlight.git

2. Enter Project Folder

Navigate into your project folder using the console.

cd highlight

3. Install NPM

Install NPM packages:

npm install

4. Install Python Packages

Install Python package requirements. You can use pip, pipenv, or conda to install the requirements. There are npm commands available for this, or you can use the provided plain commands below.

npm run install-pip

npm run install-pipenv

npm run install-conda

pip

pip install -r requirements.txt

pipenv

pipenv install  

conda

conda install --file requirements.txt

4. Generate

Generate the site!

You can use the provided npm commands to build, develop, or serve your files, or run it manually. The npm commands expect python3 to be available as an executable in the console.

You can build, develop, or simply run the server.

1. Build: Generate your site under the site/ folder.
2. Develop: Generate your site under the site/ folder, serve them at http://localhost:4242, and watch for changes in the src/ folder to regenerate the site.
3. Serve: Generate your site under the site/ folder and serve them at http://localhost:4242, without watching for changes to regenerate the site.

npm

npm run build

npm run develop

npm run server

python3

The npm shortcuts respectively represent these Python commands:

python3 main.py build

python3 main.py server --watch

python3 main.py server

If you are running Python3 executable under a different command line alias, such as python or py, you will need to adjust these commands accordingly.