Added mkdocs
This commit is contained in:
parent
44e7b3066c
commit
9a09500a14
3 changed files with 19 additions and 0 deletions
6
docs/index.md
Normal file
6
docs/index.md
Normal file
|
@ -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.
|
2
mkdocs-req.yml
Normal file
2
mkdocs-req.yml
Normal file
|
@ -0,0 +1,2 @@
|
||||||
|
mkdocs
|
||||||
|
mkdocs-material
|
11
mkdocs.yml
Normal file
11
mkdocs.yml
Normal file
|
@ -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'
|
Loading…
Reference in a new issue