essandess/easylist.github.io

Source for https://easylist.github.io/

Pelican / GitHub Project Pages Test

This repository hosts the source files for the https://easylist.github.io/ online content, which is generated using the Pelican software, and hosted at GitHub.

Synopsis

Some command line interface (CLI) examples useful for generating and reviewing content from the source files:

# Generate static content from source files, short version
pelican

# Generate static content, verbose version with explicit defaults
pelican -s pelicanconf.py -o output content

# Serve the output content at http://localhost:8000/
cd output
python -m pelican.server

Overview

Below please find an index of the most significant files and paths in this repository, including a brief explanation of their respective purpose:

content/

The content directory hosts the source files for both articles (all content/*.rst files) and additional pages (content/pages/*.rst).

output/

Files generated by Pelican are placed in the output directory by default. Note that this directory is not tracked, but generated on-demand.

pelicanconf.py

General configuration settings for the Pelican software. Please refer to http://docs.getpelican.com/en/latest/settings.html for more an introduction into the available options and additional usage notes.

.publishconf.py

Extended configuration used when publishing the online content, see http://docs.getpelican.com/en/latest/publish.html for more information.

.gitignore

Obligatoric list of files to exclude from tracking and versioning. Details are explained in the Git documentation at http://git-scm.com/docs/gitignore.