/csx-ssg

A static site generator written in Python

Primary LanguagePython

🤖 csx-ssg - a static site generator

📄 Summary

This static site generator turns markdown files into fully-fledged static pages.

It is one of the guided project assignments from the boot.dev backend course.

It supports the standard markdown syntax, such as:

  • Headers,
  • Links,
  • Images,
  • Lists,
  • Quotes,
  • Codeblocks,
  • Text formatting,
  • ... and anything else you'd expect from markdown.

🛠 Requirements

  • Python 3.9+
  • A web browser

🚀 Usage

  • Download the source code
  • Add markdown files to the /content directory. Feel free to use folders for nesting.
  • Add any static content such as stylesheets, images or videos to the /static folder. You may reference these in your markdown files.
  • Once you're done, run the main.sh script.
  • All done! Your generated site should be in the /public directory.

âš  Warning

This software was written and tested on Linux. If you are a Windows user and run into problems, feel free to open an issue or modify the source code yourself. Pull requests are welcome.