https://github.com/ozntel/ozanshare-publish-plugin

This plugin allows you to publish your markdown notes with a single click directly from your Obsidian vault.
https://github.com/ozntel/ozanshare-publish-plugin

obsidian-md obsidian-plugin private publish secret-link share

Last synced: 30 days ago
JSON representation

This plugin allows you to publish your markdown notes with a single click directly from your Obsidian vault.

• Host: GitHub
• URL: https://github.com/ozntel/ozanshare-publish-plugin
• Owner: ozntel
• Created: 2021-09-26T17:05:20.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2023-05-09T19:07:43.000Z (over 1 year ago)
• Last Synced: 2024-08-13T07:03:33.642Z (3 months ago)
• Topics: obsidian-md, obsidian-plugin, private, publish, secret-link, share
• Homepage:
• Size: 1.98 MB
• Stars: 26
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• jimsghstars - ozntel/ozanshare-publish-plugin - This plugin allows you to publish your markdown notes with a single click directly from your Obsidian vault. (Others)

README

        
# OzanShare Publish Plugin



   



This plugin allows you to publish your Markdown Notes with a single click directly from your Obsidian vault. It is available on both Mobile and Desktop.

Each of your published files will have unique code, which is only available to you. You can share with someone the link and republish once you make small changes. It will keep the same `code` and `URL`.

**IMPORTANT**: 

- This is not an open source project. 

    

- The plugin is only available to users, who are on `Exclusive Support Level`. Once you are in this support level, I will send you the `TOKEN` you can use for the plugin (Make sure that you provide your `Email address` correctly)

    

        

    

- You can also reach me out directly using the details from [Contact](#Contact) below to find out more.

**REMEMBER**: 

- This is still early stage for the plugin. There might be some bugs and missing features, which will be gradually improved, implemented. I will be grateful for your kind patience in case you see any bug, error and report me as soon as possible so that I can work on it.

To see more details, you can visit the page of `OzanShare Publish`: https://ozanshare.web.app

## See How Plugin Works



    



## Plugin Description

1. You need to be on `Exclusive Support Level` to be able to use the plugin. You will receive a `TOKEN` from me to be able to use the plugin and publish feature. Once you enter the `TOKEN` in plugin settings and click verify, you can start enjoying all features available: Exclusive Support Level

2. You can `Publish` your notes and all relevant linked notes to the main published note with a single click from the `Context Menu` of the file in the vault:

    

3. Your pages are going to be served on [https://ozanshare.web.app/](https://ozanshare.web.app/). You can check the website to see a sample published note.

4. Plugin `Renders` the followings as HTML:

    - **Any Basic Markdown Content**

    - **Linked Files**

	- **Transclusions** (and also nested)

        

    - **Admonitions**

        

    - **Excalidraw Drawings**

        

	- **Mermaids**

        

	- **MathJax**

        

	- **Code Blocks**

        

        

5. You can also add your `Custom CSS`. Go to settings and use to button to open your `Custom CSS` settings.

    

6. You can see all your published notes from the `View` created for plugin. Just click the `Ribbon Icon` and list your published notes.

    

7. As long as you don't unpublish your notes and change the place of the file in the vault, the `Republish` function will keep the old publish references. It will help you to update the files you have already shared with someone. You won't need to send a new link.

    

8. `Images` are uploaded to Firebase server, which are also served with a secret token. Image source with the provided token is automatically embedded into your final publish on OzanShare. 

9. Each publish triggers a scan of your `Published Files` and `Vault`. It means you shouldn't remove the references from `Frontmatter` manually by hand since it will trigger removing the published note from the server. You should rather use `Unpublish` button if you don't need the note anymore to be shared. This will remove the shared note from the server.

10. You can open the published notes on `Web Application` directly from the `Context Menu` or `Copy URL`, which allows to access the note on web.

## Contact

If you have any issue or you have any suggestion, please feel free to reach me out directly using contact page of my website Ozan.pl Contact or directly to .