The Wiki Generator is an Obsidian plugin designed to make it convenient to publish your notes online for others to see, while still allowing you to do all of your writing in Obsidian.
How does it work? In short, the Wiki Generator takes notes and files from your Obsidian vault and converts them into a format a website can use. It also handles special syntax that you can use to customize how your notes are displayed on the web. Then, it uploads your notes to your website, which you can get a copy of in a minute or two. Your website automatically updates to reflect these changes. Once you set things up, you only need to press a single button to sync your website with your vault.
Want an example? This plugin's documentation is entirely published using the Wiki Generator.
To begin, add this plugin to your vault and follow the Getting started guide in the documentation.
- It's free!
- Fine-grained control over what you publish - make only what you want public
- Optional user accounts allow you to make content visible only to certain users
- Make your writing public without leaving the comfort of your Obsidian vault
This plugin is still early in development and is not currently available as an official Obsidian plugin. As such, you can't find it in the plugin search within Obsidian; you will need to do a manual installation. To do so, you'll need npm installed on your system. Then, follow these steps:
- Clone this repository in the
.obsidian/pluginsfolder of whichever vault you want to use it in. You may have to show hidden folders if you are on MacOS or Linux. - Open a terminal in that folder and run
npm install. - Once it finishes installing everything, run
npm run build. - Restart Obsidian if it was open.
If you see the Wiki Generator tab in your settings, the plugin is now up and running. Follow the Getting started guide to set everything up.
This project is licensed under the Apache 2.0 license.