Skip to content

Latest commit

 

History

History
93 lines (51 loc) · 5.56 KB

README.md

File metadata and controls

93 lines (51 loc) · 5.56 KB
Raw

OzanShare Publish Plugin

chat on Discord

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 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/. 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)

      transclusions

    • Admonitions

      admonitions

    • Excalidraw Drawings

      admonitions

    • Mermaids

      mermaid-sample

    • MathJax

      mathjax-sample

    • Code Blocks

      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 me@ozan.pl.