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.

Two open source dramas in one week? Get the popcorn. From one of the links[0]:

> I do not see him as qualified to keep this project maintainership and if I had the choice, would I remove him.

…where “him” is Tom Christie, aka lovelydinosaur, the original author from what I can tell, and the copyright holder from the license file.

I don’t know what’s going on, but if someone contributing to one of my projects, that I wrote, started a public conversation about how to remove me, my public response might appear as that person disappearing from the project.

Sure, feel free to follow the license and fork the project. Make it clear that it’s a fork, though. It feels misleading to describe it as a continuation of the existing project.

[0] https://github.com/mkdocs/mkdocs/discussions/4088

MkDocs

pdoc is my go-to documentation tool for small Python projects.

However, when they start to grow, MkDocs and the Material for MkDocs theme make the most sense — they’re easy to install and deploy, and they offer a ton of features for writing engaging documentation.

[0] https://www.mkdocs.org/

In simple terms, Material for MkDocs is a theme for MkDocs, which is a static site generator specifically designed for project documentation. Think of MkDocs as a tool that converts markdown files into a neat website and the Material theme makes that website look great, inspired by Google’s Material Design principles.

# 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.