Publishing Your Module

To share your own notes with your friends, you simply have to send them the folder from your Vault and have them copy it into their own Vinaya Bookshelf.

The rest of this guide will cover what it takes to create a module that the Obsidian Plugin can track and keep up-to-date.

Creating and Hosting Your VNM on GitHub link

The easiest way to host your module is using GitHub.

The steps are as follows:

1. Sign up for a GitHub account if you don’t have one already.
2. Using the Vinaya Notes Module Template repository, create your own repo
3. Follow the instructions in its README.md to finish setting it up.

The template repository contains a GitHub Actions Script which, after you enable it, will create a new release of your module whenever you commit changes to your repository. Once the build succeeds and you have your first release, people can add your module to their vault using your vnm URL:

https://github.com/your-username/your-repo-name/releases/latest/download/manifest.vnm

Custom Hosting link

If you’d prefer to host your module yourself, you can!

Simply put up a ZIP Archive of your folder and a valid VNM File anywhere on the internet and your module can now be added in the Vinaya Bookshelf Plugin!

Feel free to email me, Khemarato Bhikkhu (at gmail.com), if you have any questions or suggestions on the publishing process or if you’d like to get your module added to the default modules list.