Quick Start

markdown_spa is a Python (jinja2 + markdown) static site generator:

• Powerful templating
• SEO optimized
• No full page reloads
• SCSS and Tailwind CSS support
• Extented Markdown syntax
• Automatic deployment to GitHub Pages

First, to setup a new project:

• Install the package (once): pip install markdown_spa
• Create a blank project: markdown_spa init <folder (optionnal)>

The config.ini file describes the project structure:

Key	Default value	Description
port	8000	Port used by the live-reload server
pages_path	pages	Root of all markdown files
assets_path	assets	Root of all assets (images, css, js, ...)
scss_path	scss	Root of all SCSS files (optionnal)
dist_path	dist	Root of the generated website
templates_path	templates	Root of all templates

And finally, to build your website you have two options:

• Standalone: markdown_spa build <folder (optionnal)>
• Live-reload: markdown_spa watch <folder (optionnal)>

If scripts aren't added to PATH, you can use python -m markdown_spa instead of markdown_spa.