From 08af02b9d1c52e822e70e0d457489da49fb3fb1e Mon Sep 17 00:00:00 2001
From: Bastian Venthur <venthur@debian.org>
Date: Fri, 16 Jun 2023 22:30:18 +0200
Subject: [PATCH] more fixes for rtd

---
 docs/CHANGELOG.md |  1 -
 docs/README.md    |  1 -
 docs/index.md     | 56 +++++++++++++++++++++++++++++++++++++++++++++++
 mkdocs.yml        |  3 +--
 4 files changed, 57 insertions(+), 4 deletions(-)
 delete mode 120000 docs/CHANGELOG.md
 delete mode 120000 docs/README.md
 create mode 100644 docs/index.md

diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
deleted file mode 120000
index 75c555f..0000000
--- a/docs/CHANGELOG.md
+++ /dev/null
@@ -1 +0,0 @@
-/home/venthur/git/blag/CHANGELOG.md
\ No newline at end of file
diff --git a/docs/README.md b/docs/README.md
deleted file mode 120000
index b52422b..0000000
--- a/docs/README.md
+++ /dev/null
@@ -1 +0,0 @@
-/home/venthur/git/blag/README.md
\ No newline at end of file
diff --git a/docs/index.md b/docs/index.md
new file mode 100644
index 0000000..daea224
--- /dev/null
+++ b/docs/index.md
@@ -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
+```
diff --git a/mkdocs.yml b/mkdocs.yml
index b461bd3..e891eaf 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -4,7 +4,7 @@ repo_url: https://github.com/venthur/blag
 repo_name: venthur/blag
 
 nav:
-  - Home: README.md
+  - Home: index.md
   - Manual: manual.md
   - API:
     - blag: blag_.md
@@ -13,7 +13,6 @@ nav:
     - blag.markdown: markdown.md
     - blag.devserver: devserver.md
     - blag.quickstart: quickstart.md
-  - Changelog: CHANGELOG.md
 
 theme:
   name: material