Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/klml/drfly

static website generator powered by Python, YAML, Markdown and mustache
https://github.com/klml/drfly

Last synced: 2 months ago
JSON representation

static website generator powered by Python, YAML, Markdown and mustache

Awesome Lists containing this project

README 

        
# drfly



static website generator powered by Python, YAML, [Python-Markdown](https://python-markdown.github.io) and [mustache](https://github.com/defunkt/pystache).



There are many other and better [staticsitegenerators](http://staticsitegenerators.net), but I missed some features.

So drfly provides:



* the __meta information__ for rendering (template, menue etc) or html metatags are defined

    * in `./meta.yaml` in the contentroot, like configuration files in most other ssg like [hugo](https://gohugo.io/getting-started/configuration/).

    * but __additionally__ in every directory (`meta.yaml`)

    * or inside the page as [jekylleske front matter](https://jekyllrb.com/docs/front-matter/), but at the __bottom__ of the page and only __optional__ (tried to use my own standard [PROSErial](https://github.com/klml/PROSErial)).

* the document or __page title__ is defined with the __first H1__ and is optional.

Most other ssg define the pagetitle in the front matter, but this is complicated and makes front matter mandatory. HTML headings, are part already a part of the document. So I need this:

    * define [HTML Title element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/title) `````` from first markdown heading as ```pagetitle``` if it is missing in meta (a function you have in [MkDocs](https://github.com/mkdocs/mkdocs/blob/master/docs/user-guide/writing-your-docs.md#meta-data)).

    * [toc_depth range](https://python-markdown.github.io/extensions/toc/#usage) to exclude H1 from toc.

* URLs with no mandatatory trailing slash.

* simple one-file templating with mustache, for plain websites. Even the simple [hugo layout templates](https://gohugo.io/templates/) drives me crazy.

I would love using [Pandoc for this](https://wstyler.ucsd.edu/posts/pandoc_website.html).

* include sourcefiles in templates (for menus, sidebars, trackingpixels). Instead of defining menus in abstract config files.

* use source directories as __namespace__, with customizing namespaceseperators (```namespace:pagetitle```) and not only ```/```.

* non .md files (```.css```, ```.js``` or ```.txt```) get rendered with newlines as breaks (```
```).

* create single pages, not always all pages at once.



When I build sites for other people I use [hugo](https://gohugo.io/).

But then I miss ```[[```Wikilinks```]]``` from [Python-Markdown](https://python-markdown.github.io).



## usage



### cli



Change to source directory and render all pages:

```

cd /path/to/source/

drfly 

```



Render all pages from source directory:

```

drfly /path/to/source/ 

```



Render single page:

```

drfly /path/to/source/index.md 

```



### web

You can use git{hu|la}b as content webinterface and versioning system.



Get new commits with [webhook.py](drfly/webhook.py) (depends on [webpy.org](http://webpy.org))



```

pip3 install -r requirements-web.txt 

python3.6 drfly/webhook.py 8080 /path/to/source/

```



* Render a single page: `http://localhost:8080/render?page=index.md`

* Render all pages, by setting "webhook: renderall" `true` in [config](#config) and: `http://localhost:8080/render?all`

* Pull git repository and render all changed pages `curl -X PO http://localhost:8080/gitpull`



### config



There is the global config [drfly/meta.global.yaml](drfly/meta.global.yaml).

You can overwrite this values with a file `meta.yaml` in the root-directory oder every sub-directory.



## rendering



Drfly renders html and json files with [Python-Markdown](https://python-markdown.github.io/) using [Markdown Extra](https://python-markdown.github.io/extensions/extra/) with [Table of Contents](https://python-markdown.github.io/extensions/toc/), [WikiLinks](https://python-markdown.github.io/extensions/wikilinks/), [Sane Lists](https://python-markdown.github.io/extensions/sane_lists/) and [Admonition](https://python-markdown.github.io/extensions/admonition/).



You can add [Third-Party-Extensions](https://github.com/Python-Markdown/markdown/wiki/Third-Party-Extensions) in [config](#config) `markdown: extensions:`