vinay/obsidian-mermaid-links
1
0
Fork 0
mirror of https://github.com/vinayaugustine/obsidian-mermaid-links.git synced 2025-12-05 20:38:59 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated README.md and license

Browse source 
* Updated README.md with basic instructions
* Change license to MIT licensed by me
This commit is contained in:
Vinay Augustine 2025-03-11 10:25:03 -04:00
parent fd9c571a6e
commit dbacb3f5af
2 changed files with 67 additions and 76 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
LICENSE
View file

@ -1,5 +1,21 @@
Copyright (C) 2020-2025 by Dynalist Inc. MIT License
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted. Copyright (c) 2025 Vinay Augustine
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

121
README.md
View file

@ -1,94 +1,69 @@
# Obsidian Sample Plugin # Obsidian Mermaid Links
This is a sample plugin for Obsidian (https://obsidian.md). A plugin for [Obsidian](https://obsidian.md) that adds convenient "Edit" and "Full Screen" links to all your Mermaid diagrams.
This project uses TypeScript to provide type checking and documentation. ## Features
The repo depends on the latest plugin API (obsidian.d.ts) in TypeScript Definition format, which contains TSDoc comments describing what it does.
This sample plugin demonstrates some of the basic functionality the plugin API can do. - Automatically adds links below any Mermaid diagram in your notes
- Adds a ribbon icon, which shows a Notice when clicked. - "Edit" link opens the diagram in [Mermaid Live Editor](https://mermaid.live/edit) for easy modification
- Adds a command "Open Sample Modal" which opens a Modal. - "Full Screen" link opens the diagram in [Mermaid Live Viewer](https://mermaid.live/view) for better visibility
- Adds a plugin setting tab to the settings page. - Customizable link text through plugin settings
- Registers a global click event and output 'click' to the console.
- Registers a global interval which logs 'setInterval' to the console.
## First time developing plugins? ## How It Works
Quick starting guide for new plugin devs: The plugin scans your notes for Mermaid code blocks and adds two links below each diagram:
- Check if [someone already developed a plugin for what you want](https://obsidian.md/plugins)! There might be an existing plugin similar enough that you can partner up with. 1. **Edit**: Opens the diagram in Mermaid Live Editor, allowing you to modify the diagram in a specialized editor
- Make a copy of this repo as a template with the "Use this template" button (login to GitHub if you don't see it). 2. **Full Screen**: Opens the diagram in Mermaid Live Viewer, providing a clean, full-screen view
- Clone your repo to a local development folder. For convenience, you can place this folder in your `.obsidian/plugins/your-plugin-name` folder.
- Install NodeJS, then run `npm i` in the command line under your repo folder.
- Run `npm run dev` to compile your plugin from `main.ts` to `main.js`.
- Make changes to `main.ts` (or create new `.ts` files). Those changes should be automatically compiled into `main.js`.
- Reload Obsidian to load the new version of your plugin.
- Enable plugin in settings window.
- For updates to the Obsidian API run `npm update` in the command line under your repo folder.
## Releasing new releases Both links use Mermaid Live's PAKO compression format to transfer your diagram code efficiently.
- Update your `manifest.json` with your new version number, such as `1.0.1`, and the minimum Obsidian version required for your latest release. ## Installation
- Update your `versions.json` file with `"new-plugin-version": "minimum-obsidian-version"` so older versions of Obsidian can download an older version of your plugin that's compatible.
- Create new GitHub release using your new version number as the "Tag version". Use the exact version number, don't include a prefix `v`. See here for an example: https://github.com/obsidianmd/obsidian-sample-plugin/releases
- Upload the files `manifest.json`, `main.js`, `styles.css` as binary attachments. Note: The manifest.json file must be in two places, first the root path of your repository and also in the release.
- Publish the release.
> You can simplify the version bump process by running `npm version patch`, `npm version minor` or `npm version major` after updating `minAppVersion` manually in `manifest.json`. 1. Open Obsidian Settings
> The command will bump version in `manifest.json` and `package.json`, and add the entry for the new version to `versions.json` 2. Go to Community Plugins and disable Safe Mode
3. Click "Browse" and search for "Mermaid Links"
4. Install the plugin and enable it
## Adding your plugin to the community plugin list Or install manually:
- Download the latest release from the [GitHub releases page](https://github.com/vinayaugustine/obsidian-mermaid-links/releases)
- Extract the files into your vault's `.obsidian/plugins/obsidian-mermaid-links` folder
- Reload Obsidian and enable the plugin in the settings
- Check the [plugin guidelines](https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines). ## Configuration
- Publish an initial version.
- Make sure you have a `README.md` file in the root of your repo.
- Make a pull request at https://github.com/obsidianmd/obsidian-releases to add your plugin.
## How to use You can customize the text displayed for both links in the plugin settings:
- Clone this repo. - **Edit Link Text**: The text to display for the edit link (default: "Edit")
- Make sure your NodeJS is at least v16 (`node --version`). - **Full Screen Link Text**: The text to display for the full screen link (default: "Full Screen")
- `npm i` or `yarn` to install dependencies.
- `npm run dev` to start compilation in watch mode.
## Manually installing the plugin ## Usage Example
- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`. 1. Create a Mermaid diagram in your note:
## Improve code quality with eslint (optional) ````markdown
- [ESLint](https://eslint.org/) is a tool that analyzes your code to quickly find problems. You can run ESLint against your plugin to find common bugs and ways to improve your code. ```mermaid
- To use eslint with this project, make sure to install eslint from terminal: graph TD
- `npm install -g eslint` A[Start] --> B{Is it working?}
- To use eslint to analyze this project use this command: B -->|Yes| C[Great!]
- `eslint main.ts` B -->|No| D[Debug]
- eslint will then create a report with suggestions for code improvement by file and line number. D --> B
- If your source code is in a folder, such as `src`, you can use eslint with this command to analyze all files in that folder:
- `eslint .\src\`
## Funding URL
You can include funding URLs where people who use your plugin can financially support it.
The simple way is to set the `fundingUrl` field to your link in your `manifest.json` file:
```json
{
"fundingUrl": "https://buymeacoffee.com"
}
``` ```
````
If you have multiple URLs, you can also do: 2. The plugin automatically adds "Edit" and "Full Screen" links below the diagram
3. Click the "Edit" link to modify your diagram in Mermaid Live Editor
4. Click the "Full Screen" link to view your diagram in a clean, full-screen interface
```json ## Compatibility
{
"fundingUrl": {
"Buy Me a Coffee": "https://buymeacoffee.com",
"GitHub Sponsor": "https://github.com/sponsors",
"Patreon": "https://www.patreon.com/"
}
}
```
## API Documentation - Requires Obsidian v0.15.0 or above
- Works with all standard Mermaid diagram types supported by Obsidian
See https://github.com/obsidianmd/obsidian-api ## License
This project is licensed under the [MIT License](LICENSE).
## Support
If you encounter any issues or have feature requests, please file an issue on the [GitHub repository](https://github.com/vinayaugustine/obsidian-mermaid-links/issues).