summaryrefslogtreecommitdiffstats
path: root/website/mkdocs.yml
diff options
context:
space:
mode:
authorCanop <cano.petrole@gmail.com>2019-03-07 20:41:49 +0100
committerCanop <cano.petrole@gmail.com>2019-03-07 20:41:49 +0100
commitf7f1ca0dc436ed9e0a9129f9444f174a82777bcb (patch)
tree8ea86a05f4fdbae41a96c3961352d249f9f60628 /website/mkdocs.yml
parentf2de057e45ee5bae8ddccb7f4db998bafe8e1947 (diff)
new documentation website
Diffstat (limited to 'website/mkdocs.yml')
-rw-r--r--website/mkdocs.yml30
1 files changed, 30 insertions, 0 deletions
diff --git a/website/mkdocs.yml b/website/mkdocs.yml
new file mode 100644
index 0000000..511e9bb
--- /dev/null
+++ b/website/mkdocs.yml
@@ -0,0 +1,30 @@
+site_name: Broot
+site_description: 'Broot, a new way to navigate directory trees on linux, made in rust'
+site_url: https://dystroy.org/broot
+repo_url: https://github.com/Canop/broot
+edit_uri: ''
+
+nav:
+ - Why: index.md
+ - Documentation:
+ - Installation: documentation/installation.md
+ - Usage: documentation/usage.md
+ - Configuration: documentation/configuration.md
+ - Tips & Tricks: documentation/tricks.md
+ # - Screens: screens/screenshots.md
+ - Community: community.md
+
+extra_css:
+ - css/extra.css
+
+theme:
+ name: mkdocs
+ custom_dir: custom_theme
+ highlightjs: true
+ hljs_languages:
+ - yaml
+ - rust
+
+markdown_extensions:
+ - admonition
+ - def_list