Skip to content

Latest commit

 

History

History
49 lines (33 loc) · 1.86 KB

manual-install.md

File metadata and controls

49 lines (33 loc) · 1.86 KB
Raw

Installing Pelican by hand

The site uses Pelican for static html generation. Pelican requires Python 3.5+ and can be installed with pip.

The build.sh script mentioned in README is the easiest way of building the site using Docker. If for some reason you want to install Python and Pelican by hand, here are the steps:

Install Python 3

First, you need to install Python 3. You can download the latest version from the Python website or use your package manager to install it. For example, on macOS:

brew install python

Install Pelican

To install pelican and requirements, simply run the following command in the root of the repository:

pip3 install -r requirements.txt

If you run into conflicts with existing packages, a solution is to use a virtual Python environment. See the Pelican installation page for more details. These are quick commands, Linux flavor:

python3 -m venv env
source env/bin/activate
pip install -r requirements.txt

Once Pelican is installed you can convert your content into HTML via the pelican command (content is the default location to build from).

pelican

The above command will generate your site and save it in the output/ folder using the solr theme and settings defined in pelicanconf.py

You can also tell Pelican to watch for your modifications, instead of manually re-running it every time you want to see your changes. To enable this, run the pelican command with the -r or --autoreload option. On non-Windows environments, this option can also be combined with the -l or --listen option to simultaneously both auto-regenerate and serve the output through a builtin webserver on http://localhost:8000.

pelican --autoreload --listen