Use `markdown` for docs on wiki?

[goodboy]

We obviously need docs :joy:

One of the reasons we haven't written many (besides everything being in bleeding edge flux atm) is that I don't love sphinx and I don't love editing markdown from web UI editors..

I started using obsidian a few days ago and i'm kinda sold on it being the best tina-ready app for doing org-mode like things.

BUT IT A'INT FOSS boss..

Why:

• lowest latency electron app i've ever touched
• has vim-mode, though still have some "quiffs":
  • can't ctl-d to half page down..
• has a good community where i was able to solve my own problems:
  • "https://github.com/xnhp/obsidian-cursor-blink",
  • "https://github.com/esm7/obsidian-vimrc-support",
• has support for math:"https://github.com/ocapraro/obsidian-math-plus",
• has support for mermaid.js diagramming :boom:
  • "https://github.com/dartungar/obsidian-mermaid"
  • "https://heymichellemac.com/knowledge-management-flow-diagram-in-obsidian"
• all local storage is local and each vault can be mapped to a repo(s) in bit

---

Wut we need for docs on wiki

As preface take a look at how ranger does it's user guide on the github wiki https://github.com/ranger/ranger/wiki/Official-user-guide

Ideally we can have the src code and docs all together on the wiki and managed entirely through git + obsidian. This would allow our non-coder users to edit either using GH's web UI directly or if they so choose to use obsidian. Obviously i think devs will want the latter :joy:

research:

• vault syncing with git plugin: https://github.com/denolehov/obsidian-git
• forum post on quirks with GH wikis: https://forum.obsidian.md/t/github-wiki-kinda-works-to-host-the-wiki/2980
• alternatively doing similar with gitlab pages: https://about.gitlab.com/blog/2022/03/15/publishing-obsidian-notes-with-gitlab-pages/

Probably much more to come on this..