Static site generator

A static site generator built with Python. It takes Markdown files and turns them into a static website of HTML.

Prerequisites

• You need to have Python installed in your PC.

Note: This project was built and tested in Debian 12 using Python version 3.12.3.

Run Locally

• Fork and clone the repo.
• Go to the repo directory.
• Add your static files (like CSS and Images) to the static/ directory.
• Add your markdown files to the content/ directory.
• Inside repo's root directory run the ./main.sh command in the terminal.
• Go to http://localhost:8888 to view the web site.

Note: Example files are provided in content/ and static/ directories.

Running Tests

Inside repo's root directory run the ./test.sh command in the terminal to run tests.

Features

Supported markdown syntaxes:

• Heading
• Bold texts
• Italic texts
• Blockquote
• Unordered list
• Ordered list
• Inline code
• Code block
• Link
• Image

Note: Currently, nesting inline elements (like "bold italic" word) does not work.

Acknowledgment

This project is a part of BOOT.DEV, an online course to learn back-end development.