Added mkdocs

2022-01-27 16:47:14 +01:00 · 2022-01-27 16:47:14 +01:00 · 9a09500a14
commit 9a09500a14
parent 44e7b3066c
3 changed files with 19 additions and 0 deletions
--- a/docs/index.md
+++ b/docs/index.md
@ -0,0 +1,6 @@
+# Welcome to goshorly
+
+goshorly is an easy to use and self-hostable link shortener. It is based on the Golang programming language. Redis is used as the database.
+
+## Disclaimer
+This site is work in progress and does not contain the full docs.
--- a/mkdocs-req.yml
+++ b/mkdocs-req.yml
@ -0,0 +1,2 @@
+mkdocs
+mkdocs-material
--- a/mkdocs.yml
+++ b/mkdocs.yml
@ -0,0 +1,11 @@
+site_name: goshorly docs
+site_url: https://phil.mekelek.de/goshorly
+repo_url: https://git.ucode.space/Phil/goshorly
+site_dir: docs-public
+theme:
+  name: material
+  locale: en
+  highlightjs: true
+
+nav:
+  - Home: 'index.md'