A lightweight static site generator built in Python that converts Markdown content into HTML pages. View the live demo.
- Converts Markdown files to styled HTML pages
- Supports common Markdown syntax:
- Headers (H1-H6)
- Bold and italic text
- Code blocks with syntax highlighting
- Blockquotes
- Ordered and unordered lists
- Links and images
- Custom HTML template system
- Automatic navigation between pages
- Clean, responsive design with custom CSS styling
- Preserves directory structure from content to output
- Place your Markdown content files in the
content/directory - Add any static assets (images, CSS) to the
static/directory - Build the site:
./build.shThis will:
- Copy static assets to the
docs/directory - Convert all Markdown files to HTML
- Generate the complete site structure
To run the test suite:
./test.shTo preview locally:
./main.shThen visit http://localhost:8888
This generator is build with Python as part of the Boot Dev Backend Path (the Guided Project Build a Static Site Generator in Python) and includes:
- Markdown parsing and HTML generation
- Custom text node system for inline formatting
- Template variable replacement
- File path handling and directory structure preservation
- Comprehensive unit test suite
A demonstration of this project is available at Github Pages.
This project is licensed under the GNU General Public License v3.0.