headr
is a plugin for Obsidian (https://obsidian.md) that automagically adds frontmatter to markdown files.
- make frontmatter customizable
- add warnings for misformatted frontmatter
At a minimum you need main.js
, styles.css
, manifest.json
to have a working plugin.
- Create a new Obsidian Vault for testing purposes.
- Clone this repo into the
.obsidian/plugins/your-plugin-name
folder. - Run
bun i
andbun run build
to get started.
![TIP] To continuously build the project run
bun run dev
.
![WARNING] Make sure to check code quality!
bunx eslint main.ts
A new release needs to have changes in manifest.json
and package.json
.
- Update
manifest.json
with your newminAppVersion
and the minimum Obsidian version required . - Run
bun version patch|minor|major
.
- Check https://github.com/obsidianmd/obsidian-releases/blob/master/plugin-review.md
- 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.