1
0
mirror of https://github.com/venthur/blag.git synced 2025-11-25 20:52:43 +00:00

more fixes for rtd

This commit is contained in:
Bastian Venthur
2023-06-16 22:30:18 +02:00
parent a6e0a7168c
commit 08af02b9d1
4 changed files with 57 additions and 4 deletions

View File

@@ -1 +0,0 @@
/home/venthur/git/blag/CHANGELOG.md

View File

@@ -1 +0,0 @@
/home/venthur/git/blag/README.md

56
docs/index.md Normal file
View File

@@ -0,0 +1,56 @@
# Welcome to blag!
blag is a blog-aware, static site generator, written in [Python][].
* an example "deployment" can be found [here][venthur.de]
* online [documentation][] is available on https://readthedocs.org.
blag is named after [the blag of the webcomic xkcd][blagxkcd].
[python]: https://python.org
[blagxkcd]: https://blog.xkcd.com
[venthur.de]: https://venthur.de
[documentation]: https://blag.readthedocs.io/en/latest/
## Features
* Write content in [Markdown][]
* Good looking default theme
* 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/
## Install
blag is available on [PyPI][], you can install it via:
```bash
$ pip install blag
```
On Debian or Ubuntu, you can also just install the Debian package:
```bash
$ sudo aptitude install blag
```
## Quickstart
```bash
$ pip install blag # 1. install blag
$ blag quickstart # 2. create a new site
$ vim content/hello-world.md # 3. create some content
$ blag build # 4. build the website
```

View File

@@ -4,7 +4,7 @@ repo_url: https://github.com/venthur/blag
repo_name: venthur/blag repo_name: venthur/blag
nav: nav:
- Home: README.md - Home: index.md
- Manual: manual.md - Manual: manual.md
- API: - API:
- blag: blag_.md - blag: blag_.md
@@ -13,7 +13,6 @@ nav:
- blag.markdown: markdown.md - blag.markdown: markdown.md
- blag.devserver: devserver.md - blag.devserver: devserver.md
- blag.quickstart: quickstart.md - blag.quickstart: quickstart.md
- Changelog: CHANGELOG.md
theme: theme:
name: material name: material