search

open-voice-interoperability / docs-archived

A repo containing OVON published and WIP artifacts, docs, etc. BETA site is available on github.io.
https://open-voice-network.github.io/docs
Apache License 2.0
15 stars 12 forks source link

Render markdown docs in a Hugo Docsy site #164

Closed pmotch closed 2 years ago

pmotch commented 3 years ago

Will make the docs able to be richer than the afforded things one can do in GitHub alone (things like Mermaid diagrams, shortcodes, etc). See https://github.com/open-voice-network/docs/pull/159#pullrequestreview-596808451

ghost commented 2 years ago

I can't find any good static site generators that support Mermaid + HTML details blocks. Just The Docs is a good first step, so I'm moving forward with that.

pmotch commented 2 years ago

Since the time I originally wrote this, I'm all in on Asciidoctor. So much more capable and great to write docs. If you're still on the hunt I recommend Asciidoc + Antora + Kroki for diagrams. +1 for that path though if you need to move forward.