summaryrefslogtreecommitdiffstats
path: root/mkdocs.yml
diff options
context:
space:
mode:
authorBenjamin Brahmer <info@b-brahmer.de>2021-05-08 14:34:58 +0200
committerBenjamin Brahmer <info@b-brahmer.de>2021-05-19 14:58:29 +0200
commit79e469fd335133671185cf8539f77ef38ac3b4e6 (patch)
tree4e2b7075e85225c9ac93cf78c7ef1e95b78e5ac4 /mkdocs.yml
parent271b6ee3c993264bd44a966b82f1a5daa85f53ab (diff)
Refactor News documentation with mkdocs and mkdocs-material
- move all pages to new structure - use gh-pages to host html version - use github actions for automatic build Co-authored-by: anoy <anoymouserver+github@mailbox.org> Signed-off-by: Benjamin Brahmer <info@b-brahmer.de>
Diffstat (limited to 'mkdocs.yml')
-rw-r--r--mkdocs.yml35
1 files changed, 35 insertions, 0 deletions
diff --git a/mkdocs.yml b/mkdocs.yml
new file mode 100644
index 000000000..5773ea5d2
--- /dev/null
+++ b/mkdocs.yml
@@ -0,0 +1,35 @@
+site_name: Nextcloud News App
+repo_url: https://github.com/nextcloud/news
+edit_uri: blob/master/documentation/
+
+nav:
+ - index.md
+ - install.md
+ - clients.md
+ - admin.md
+ - faq.md
+ - Features:
+ - Custom CSS: features/customCSS.md
+ - Plugins: features/plugins.md
+ - Themes: features/themes.md
+ - REST API:
+ - API v1: api/api-v1.md
+ - API v2: api/api-v2.md
+ - maintenance.md
+
+theme:
+ name: material
+ logo: assets/logo.svg
+ favicon: assets/favicon.png
+ font: false
+ features:
+ - navigation.indexes
+ - navigation.tracking
+ - navigation.instant
+ - navigation.expand
+ - navigation.sections
+
+
+# extra:
+# version:
+# provider: mike