https://github.com/mark-when/obsidian-plugin
Markwhen obsidian plugin
https://github.com/mark-when/obsidian-plugin
Last synced: 4 days ago
JSON representation
Markwhen obsidian plugin
- Host: GitHub
- URL: https://github.com/mark-when/obsidian-plugin
- Owner: mark-when
- License: mit
- Created: 2024-04-28T11:29:49.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-01-09T17:20:14.000Z (3 months ago)
- Last Synced: 2025-04-03T13:17:33.839Z (13 days ago)
- Language: TypeScript
- Size: 2.24 MB
- Stars: 319
- Watchers: 11
- Forks: 10
- Open Issues: 34
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- project-awesome - mark-when/obsidian-plugin - Markwhen obsidian plugin (TypeScript)
README
# Markwhen Obsidian Plugin
# Instructions
This plugin integrates [Markwhen](https://github.com/mark-when/markwhen/) into [Obsidian.md](https://obsidian.md/). You can use markwhen syntax to create timelines.
> [!Note]
> Latest release: 0.0.4
> Document version: 0.0.4
## Installation
> [!Note]
> Make sure that you are not in the **Restricted Mode**.
### Install from official plugin distribution
1. In Obsidian, open **Settings**.
2. Under **Community plugins**, click **Browse**.
3. Search for "Markwhen" and then select it.
4. Select **Install**, then enable it.
You can also find and install Markwhen plugin here:
### Install via BRAT
Register `https://github.com/mark-when/obsidian-plugin` in [BRAT](https://github.com/TfTHacker/obsidian42-brat) to receive upcoming releases automatically before we got reviewed from Obsidian team!
### Install the plugin manually
1. Go to the repo's latest [release page](https://github.com/mark-when/obsidian-plugin/releases/latest), and download `main.js`, `manifest.json` and `styles.css` (or the zip file).
2. Copy these files to your local path `[your vault]/.obsidian/plugins/markwhen/`.
3. Relaunch Obsidian, or refresh the plugin list, you will see this plugin.
4. In the plugin list, enable `Markwhen` and enjoy!
## Development
Ensure you first have Obsidian installed, and set up a development vault.
You can download and enable the [Hot-Reload](https://github.com/pjeby/hot-reload) plugin in the dev vault to experience a smooth debugging workflow. Every time `main.js`, `manifest.json` or `styles.css` updates, it will trigger an auto-reload.
### Linux / MacOS developers
If the path to your vault is something other than `~/Documents/Obsidian Vault`, update `copyAssets.sh` to point to your vault's location.
```sh
git clone [email protected]:mark-when/obsidian-plugin.git
cd obsidian-plugin
npm i
npm run vite
```
### Windows developers
Since there's no watch command out-of-the-box, you can place the repo right in the dev vault config directory (i.e. `[your vault]/.obsidian/plugins/markwhen/`), and set the `outDir` to `./` in `vite.config.ts` (vite complains about this).
```cmd
cd your-dev-vault/.obsidian/plugins
git clone [email protected]:mark-when/obsidian-plugin.git markwhen
cd markwhen
npm i
npm run vite
```
> [!Note]
> The plugin id in the manifest is `markwhen`, indicating users will find their plugin under the `.obsidian/plugins/markwhen` directory if they install this plugin from official Obsidian distribution.