mirror of
https://github.com/venthur/blag.git
synced 2025-11-25 12:42:41 +00:00
54 lines
1.2 KiB
ReStructuredText
54 lines
1.2 KiB
ReStructuredText
.. blag documentation master file, created by
|
|
sphinx-quickstart on Sun Mar 21 13:39:00 2021.
|
|
You can adapt this file completely to your liking, but it should at least
|
|
contain the root `toctree` directive.
|
|
|
|
Welcome to blag!
|
|
================
|
|
|
|
blag is a blog-aware, static site generator, written in Python_. An example
|
|
"deployment" can be found here_.
|
|
|
|
blag is named after the blag of the webcomic xkcd_.
|
|
|
|
.. _python: https://python.org
|
|
.. _xkcd: https://blog.xkcd.com
|
|
.. _here: https://venthur.de
|
|
|
|
|
|
Features
|
|
--------
|
|
|
|
* Write content in Markdown_
|
|
* Theming support using Jinja2_ templates
|
|
* Generation of Atom feeds for blog content
|
|
* Fenced code blocks and syntax highlighting using Pygments_
|
|
* Integrated devserver
|
|
* Available on PyPI_
|
|
|
|
blag runs on Linux, Mac and Windows and requires Python >= 3.8
|
|
|
|
.. _markdown: https://daringfireball.net/projects/markdown/
|
|
.. _jinja2: https://palletsprojects.com/p/jinja/
|
|
.. _pygments: https://pygments.org/
|
|
.. _pypi: https://pypi.org/project/blag/
|
|
|
|
|
|
Documentation
|
|
=============
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Contents:
|
|
|
|
|
|
blag.rst
|
|
api.rst
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|