obsidian-plugin/mark-when_obsidian-plugin
1
0
Fork 0
mirror of https://github.com/mark-when/obsidian-plugin.git synced 2026-07-22 10:10:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
66 commits 6 branches 8 tags 2.3 MiB
TypeScript 96.9%
JavaScript 1.6%
CSS 0.9%
Shell 0.6%
Find a file
Acylation 9db8159077 Remove .cm-content decoration
2024-05-04 17:04:30 +08:00
.github/ISSUE_TEMPLATE Set up issue/pr templates 2023-09-12 00:31:44 +08:00
src Add markwhen-view style 2024-05-04 16:56:12 +08:00
.editorconfig Initial commit 2023-08-09 16:35:03 +08:00
.eslintignore Initial commit 2023-08-09 16:35:03 +08:00
.eslintrc Initial commit 2023-08-09 16:35:03 +08:00
.gitattributes Initial commit 2023-08-09 16:35:03 +08:00
.gitignore Initial commit 2023-08-09 16:35:03 +08:00
.npmrc Initial commit 2023-08-09 16:35:03 +08:00
.prettierignore Initial commit 2023-08-09 16:35:03 +08:00
.prettierrc Initial commit 2023-08-09 16:35:03 +08:00
copyAssets.sh Remove asset copy line 2024-05-01 18:06:05 -07:00
LICENSE Update LICENSE 2024-05-02 11:36:02 +08:00
manifest.json Version bump 2024-05-01 16:23:04 +08:00
package-lock.json Version bump 2024-05-01 16:23:04 +08:00
package.json Update scripts 2024-05-01 20:46:19 +08:00
README.md Update README.md 2024-05-02 02:49:47 +08:00
screenshot.png add screenshot 2024-04-28 09:00:27 -07:00
styles.css Remove .cm-content decoration 2024-05-04 17:04:30 +08:00
tsconfig.json Make VSCode happy with vite static import 2024-05-01 11:54:33 +08:00
version-bump.mjs Initial commit 2023-08-09 16:35:03 +08:00
versions.json Initial commit 2023-08-09 16:35:03 +08:00
vite.config.ts clean up 2024-04-28 08:43:22 -07:00

README.md

Markwhen Obsidian Plugin

markwhen-obsidian-plugin

Obsidian Downloads

This plugin integrates Markwhen into Obsidian.md. You can use markwhen syntax to create timelines.

Note

Latest release: 0.0.1
Document version: 0.0.1

Installation

Note

Make sure that you are not in the Restricted Mode.

Install the plugin manually

  1. Go to the repo's latest release page, 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!

Install via BRAT

Register https://github.com/mark-when/obsidian-plugin in BRAT to receive upcoming releases automatically before we got reviewed from Obsidian team!

Development

Ensure you first have Obsidian installed, and set up a development vault.

You can download and enable the 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.

git clone git@github.com: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).

cd your-dev-vault/.obsidian/plugins
git clone git@github.com: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.