Added Github Page

mkdocs.yml

@@ -0,0 +1,140 @@
+site_name: Cadmus
+docs_dir: './docs'
+
+# EVERYTHING must be below whatever the docs_dir is,
+# otherwise mkdocs won't work.
+# So move attachments into notes and then symlink back to ../notes so it is both compatible with ios local file preview and notable
+use_directory_urls: false #directory urls are considered better, but this will allow local file previews on ios through working copy.
+# nav:
+#     - Home: index.md
+#     - About: about.md
+extra_css:
+        - css/SpaceMacsNotableFirst.css
+        #- css/dracula.css
+markdown_extensions:
+  - codehilite:
+      linenums: false 
+  - toc:
+      permalink: true # Careful, these links are bad over local network
+  - pymdownx.arithmatex
+  - footnotes
+  - admonition
+  - pymdownx.betterem:
+      smart_enable: all
+  - pymdownx.caret
+  - markdown.extensions.attr_list
+  - pymdownx.critic
+  - pymdownx.details
+  - pymdownx.emoji:
+      emoji_generator: !!python/name:pymdownx.emoji.to_svg
+  - pymdownx.inlinehilite
+  - pymdownx.magiclink
+  - pymdownx.keys
+  - pymdownx.mark
+  - pymdownx.smartsymbols
+  - pymdownx.superfences
+  - pymdownx.tasklist:
+      custom_checkbox: true
+  - pymdownx.tilde
+    ##### copy/paste from [[https://github.com/mkdocs/mkdocs/issues/1687][here]] in order to get summary boxes working
+  - pymdownx.arithmatex
+  - pymdownx.betterem:
+     smart_enable: all
+  - pymdownx.caret
+  - pymdownx.critic
+  - pymdownx.details
+  - pymdownx.emoji:
+     emoji_generator: !!python/name:pymdownx.emoji.to_svg
+  - pymdownx.inlinehilite
+  - pymdownx.magiclink
+  - pymdownx.mark
+  - pymdownx.smartsymbols
+  - pymdownx.superfences
+  - pymdownx.tasklist:
+     custom_checkbox: true
+  - pymdownx.tilde
+  - pymdownx.betterem
+  - pymdownx.superfences
+  - markdown.extensions.footnotes
+  - markdown.extensions.attr_list
+  - markdown.extensions.def_list
+  - markdown.extensions.tables
+  - markdown.extensions.abbr
+  - pymdownx.extrarawhtml
+
+
+extra_javascript:
+  - 'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-MML-AM_CHTML'
+plugins:
+    - mkdocs-nav-enhancements # This causes titles in the nav to be replaced with Heading 1
+    - search:
+        prebuild_index: True
+        prebuild_index: true
+        #        separator: '[\s\-\.]+'
+#        prebuild_index: true # for ~100 of pages this helps (https://www.mkdocs.org/user-guide/configuration/#project-information)
+        # Takes away live search, the sidebar doesn't work inside notes,
+        # side bar is non-standard anyway.
+        #theme:
+        #    name: readthedocs
+        #    highlightjs: true
+        #    navigation_depth: 6
+        #    collapse_navigation: False
+        #    hljs_languages:
+        #        - yaml
+        #        - rust
+
+#
+#
+# Why not the Material Theme!
+#   It supports some extensions and it looks great, but
+#
+#   It doesn't allow me to use dracula for code blocks,
+#   dracula is way more readable, so theres no choice.
+#
+#   It supports markdown inside  the details block though
+#   so I have no choice, maybe using ! important will let me
+#   make code blocks more readable
+#
+theme:
+    name: 'material'
+# this has a better search than readthedocs or default
+    # I don't think any other theme searches text
+    # This also wraps links unlike the default text way better than the default
+    # But it doesn't work with Dracula so fuck it
+# theme: gitbook # No Preview!
+#theme: cinder
+
+        
+        
+        # extra_javascript:
+#   - 'javascripts/extramath.js'
+#   - 'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-MML-AM_CHTML'
+#             #  - 'https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.9.0/katex.min.js'
+# extra_css: 
+# #  - 'https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.9.0/katex.min.css'
+# 
+# 
+# 
+        #theme:
+        #    name: mkdocs
+        #    highlightjs: true
+        #    hljs_languages:
+        #        - yaml
+        #        - rust
+        #        - bash
+        #        - zsh
+        #        - fish
+        #        - r
+        #        - mathematica
+        #        - matlab
+        #        - fortran
+        #        - c
+        #        - java
+        #        - javascript
+        #        - markdown
+        #        - coffeescript
+        #        - lua
+        #        - vimscript
+        #        - tex
+        #        - tex
+        #          # important, all highlighting code must be lower case