Static site generator for GitHub Pages
Project description
Genja
Genja is a simple static site generator for GitHub Pages. It is a command line tool built in Python that generates HTML files and a JSON feed from Markdown content.
Installation
Download and install Python from python.org or from Anaconda. Next, install genja from PyPI using the following command:
pip install genja
Check the installed version from the command line:
genja --version
Usage
Before running genja, create a project structure as shown below. The content
directory contains Markdown files that are used to generate HTML files. The templates
directory contains Jinja templates that are used to render the HTML pages. The docs
directory contains the built website which can be hosted with GitHub Pages. Lastly, the config.json
defines the URLs and directories for the project.
mywebsite/
|- content/
|- templates/
|- docs/
|- config.json
The items in the config.json
are shown below. The base_url
is the URL for the homepage of the website. Markdown files that are parsed by genja are located in the input_dir
directory. The HTML files generated from genja are located in the output_dir
directory. Static content such as images and CSS files should go in the output directory.
{
"base_url": "https://example.com/mywebsite",
"input_dir": "content",
"output_dir": "docs"
}
Use the serve command to view the website in the default browser.
genja serve
Use the build command to build the website for hosting with GitHub Pages.
genja build
Example
To run the example, go to the example
directory in this repository. The mdcontent
is the input directory containing the Mardkown files. The website
is the output directory containing the built HTML files. Use the commands shown below to serve the generated website and open a web browser.
cd example
genja serve
Use the commands shown below to build the example website without starting a server.
cd example
genja build
Contributing
Clone this repository and use the conda environment file to create a Python environment for developing genja. This environment uses flake8 for linting and pytest for running tests. Genja is installed in editable mode within the environment.
# Clone the project
git clone https://github.com/wigging/genja.git
# Create the conda environment
cd genja
conda env create --file environment.yml
# Activate the conda environment
conda activate genja
License
This project is licensed under the terms of the MIT license. See here for the license text.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.