From 9a09500a141632bd8f81df4e20555c693f1123be Mon Sep 17 00:00:00 2001 From: Phil Date: Thu, 27 Jan 2022 16:47:14 +0100 Subject: [PATCH] Added mkdocs --- docs/index.md | 6 ++++++ mkdocs-req.yml | 2 ++ mkdocs.yml | 11 +++++++++++ 3 files changed, 19 insertions(+) create mode 100644 docs/index.md create mode 100644 mkdocs-req.yml create mode 100644 mkdocs.yml diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..e642695 --- /dev/null +++ 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. \ No newline at end of file diff --git a/mkdocs-req.yml b/mkdocs-req.yml new file mode 100644 index 0000000..21f876b --- /dev/null +++ b/mkdocs-req.yml @@ -0,0 +1,2 @@ +mkdocs +mkdocs-material \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..1c09a75 --- /dev/null +++ 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' \ No newline at end of file