obsidian-export VS MkDocs

Found: https://github.com/zoni/obsidian-export but hope this can be part of a single solution.

I use this obsidian-export CLI program to convert prior to pushing to my repo and it's been working pretty well. This gives me a read-only version of my notes that is accessible from devices I don't have obsidian on (work laptop, for example).

If you limit your use of third party plugins, you can always use https://github.com/zoni/obsidian-export for this as well. I originally built it for exactly this use case (but now also use it as a crucial step in my pipeline to publish content to my own website)

It came from here! https://github.com/zoni/obsidian-export

Worth noting I maintain a project which does exactly this: https://github.com/zoni/obsidian-export

I have similar folders to [Oudwin](https://www.reddit.com/user/Oudwin/)... - dm - _inbox - assets - checklist - communications - research-reference - elements - sessions Additionally, I have had reasonable success using [obsidian-export](https://github.com/zoni/obsidian-export) to export my Obsidian vault to CommonMark. From there you have more options. I then build html pages using [mdbook](https://rust-lang.github.io/mdBook/) to control the information that is revealed to players. I am playing with using [MkDocs](https://www.mkdocs.org/) to see if it offers more control/flexibility. Regardless, the /elements folder contains all the lore chunks of the world including information I keep on the PCs. The /communications and /sessions folders can contain info with links to /elements that are revealed as needed. I make heavy use of transclusion ![[CoolThingFormAnotherFolder]] to keep it a bit more elegant and some custom styles are needed to make it how it look how I wish.

I have had reasonable success using obsidian-export to export a vault to CommonMark. From there you have more options. I am using it for world-building in D&D and I then build html pages using mdbook to control the information that is revealed to players.

Shameless plug: obsidian-export. It will convert [[WikiLinks]] and ![[Embeds]] to plain Markdown (among a few other things) so you'll always have a way to go back if Obsidian doesn't work out the way you hoped.

So really you can't get what you want at all. You could try an external tool like this to export your notes to commonmark which is more widely supported. Ultimately if you are changing the path to files outside of obsidian (meaning they won't be automatically updated) you will break links. So maybe your best bet is to use wikilinks + an export tool.

# Welcome to MkDocs For full documentation visit [mkdocs.org](https://www.mkdocs.org). ## Commands * `mkdocs new [dir-name]` - Create a new project. * `mkdocs serve` - Start the live-reloading docs server. * `mkdocs build` - Build the documentation site. * `mkdocs -h` - Print help message and exit. ## Project layout mkdocs.yml # The configuration file. docs/ index.md # The documentation homepage. ... # Other markdown pages, images and other files.

The documentation is built with MkDocs and hosted on GitHub Pages. You can browse the complete documentation at carpet.jerolba.com.

MkDocs

MkDocs is a static site generator designed specifically for project documentation and written in Python. It’s easy to set up, uses markdown for content, and features a number of themes, including the popular Material for MkDocs. MkDocs integrates well with Python-based workflows and CI/CD tools. It’s a great choice for Python developers and teams looking for simplicity and readability.

Because of my frustrations, I've released two example GitHub repositories for two popular static site generators: MkDocs and Sphinx. The goal with these repositories is to be focussed on a minimal project using the static site generator, that builds into a Read The Docs theme compatible website, and provide supporting tooling regarding formatting of the underlying formatting language. It also provides the tooling needed to deploy to GitHub Pages both from the command line and via GitHub Actions (both are powered by the ghp-import project).

The documentation of the CLI is provided via a GitHub page as part of the repository. We are using MkDocs to generate the content, but I think most of the tools in that area are well integrated with GitHub and GitHub Actions.

The original mkdocs uses a Python package for its installer, so you can just pip install mkdocs, mkdocs new ., and then mkdocs build to convert markdown files into HTML.

If you don't like to run javascript outside of a browser, MkDocs is a great Python-based alternative: https://www.mkdocs.org/

I like Markdown because it's simple and doesn't give me that many headaches.

You know what I don't like? HTML, for user submitted content in particular. The mess I've seen, after someone opted for using HTML for messages in a system, because that's what JS based editors were available for at the time. Endless need to work against XSS, with more and more incremental updates needed to the sanitization logic, some of which broke the presentation of the data in the DB.

Never again. Markdown, BBCode, anything but that.

As for docs? Currently just some Markdown, because that's what GitHub, GitLab, Gitea and others all know how to render.

Maybe something like https://www.mkdocs.org/ for the more standalone use cases.

Developing the documentation website using an open-source static site generator like Sphinx or MkDocs to build the files locally through the command line, rather than using a commercial program.