aboutsummaryrefslogtreecommitdiff
path: root/mkdocs.yml
diff options
context:
space:
mode:
authorSilvio Rhatto <rhatto@riseup.net>2022-12-10 13:27:08 -0300
committerSilvio Rhatto <rhatto@riseup.net>2022-12-10 13:27:08 -0300
commit9ae0b0e661b9c887749f48e11657d720fe7482d0 (patch)
treea12e696221e05144495e84304006d28b885fdc26 /mkdocs.yml
parent8abcfb4305fb4ed20a72eb3758467314a955c0e4 (diff)
downloadtemplates-9ae0b0e661b9c887749f48e11657d720fe7482d0.tar.gz
templates-9ae0b0e661b9c887749f48e11657d720fe7482d0.tar.bz2
Fix: convert to MkDocs
Diffstat (limited to 'mkdocs.yml')
-rw-r--r--mkdocs.yml32
1 files changed, 32 insertions, 0 deletions
diff --git a/mkdocs.yml b/mkdocs.yml
new file mode 100644
index 0000000..41c0bee
--- /dev/null
+++ b/mkdocs.yml
@@ -0,0 +1,32 @@
+#
+# Mkdocs configuration
+#
+
+site_name: Protocolos
+docs_dir : docs
+site_dir : site
+
+# Site address is bind to 0.0.0.0 so it works find inside a Docker container.
+# A better config would be desirable.
+dev_addr : '0.0.0.0:8040'
+
+theme:
+ name : readthedocs
+ collapse_navigation: true
+ titles_only : false
+
+extra_css:
+ - site.css
+
+plugins:
+ - search
+
+ # BibTeX support using mkdocs-bibtex
+ # https://pypi.org/project/mkdocs-bibtex/
+ # https://github.com/shyamd/mkdocs-bibtex
+ #- bibtex:
+ # bib_dir : "catalogs/biblio"
+ # csl_file : "apa.csl"
+
+markdown_extensions:
+ - footnotes