Ethereal to Make Docs

A framework using Python to convert a collection of Markdown files into a website

A very light framework for building a static website or individual webpages that results in pages about as lightweight as they can be, having only the functionality you desire.

Uses python-markdown to render one or more Markdown files to HTML. If multiple source files are rendered, a site is created with an equivalent file structure. Works similar to MkDocs; HTML/CSS layout was derived from Material for MkDocs.

The python script is small, and has much less functionality than MkDocs. The HTML/CSS framework is small, and has much less functionality than Material. The entire project is so tiny it’s almost ethereal.

The beneficial tradeoff of its diminutive size is flexibility. It’s in between starting from scratch and using a full-fledged framework like Material, but much closer to the former. Also note that much of the functionality of MkDocs & Material can be derived directly from functionality available in the python-markdown package if you wish to add it manually.

If you need to build a website, or even a single webpage without having to add all the functionality yourself, then check out the excellent MkDocs & Material for MkDocs. If you want to make a few lightweight webpages similar in layout and responsiveness to Material, or if you want to make a substantial website and are willing to add features as necessary, then Ethereal to Make Docs might be a good starting point for you.

Features

• Python-markdown renderer: page’s source written in markdown
• Responsive design
• Primary & secondary tables of contents
• Python script automatically creates the secondary table of contents
• Scrollspy
• View/edit source buttons
• Theme button to toggle between light, dark, and default themes
• Easily customizable with direct HTML/CSS coding.

Demo site

See this live demo

Example of a live site using this package: HyLown.com

Responsive screenshots

Fullsize

Tablet

Phone

To suggest an edit or correction to this page, please click the "Edit this page" button below or at the top to access the source file on GitHub.