https://github.com/vesan/obsidian-markdown-headings

Obsidian plugin to increase and decrease depth of headings
https://github.com/vesan/obsidian-markdown-headings

markdown obsidian-md

Last synced: about 1 month ago
JSON representation

Obsidian plugin to increase and decrease depth of headings

• Host: GitHub
• URL: https://github.com/vesan/obsidian-markdown-headings
• Owner: vesan
• Created: 2022-02-22T09:22:01.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2022-02-26T09:09:40.000Z (almost 3 years ago)
• Last Synced: 2024-11-06T22:45:24.194Z (3 months ago)
• Topics: markdown, obsidian-md
• Language: TypeScript
• Homepage:
• Size: 36.1 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Obsidian Markdown Headings

Thi is a [Obsidian](https://obsidian.md) plugin to increase and decrease depth of headings. So for example going from `## My Heading` to `# My Heading` or `### My Heading`.

This project uses Typescript to provide type checking and documentation.

The repo depends on the latest plugin API (obsidian.d.ts) in Typescript Definition format, which contains TSDoc comments describing what it does.

## Releasing new releases

- Update your `manifest.json` with your new version number, such as `1.0.1`, and the minimum Obsidian version required for your latest release.

- 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`.

> The command will bump version in `manifest.json` and `package.json`, and add the entry for the new version to `versions.json`

## Adding your plugin to the community plugin list

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

## How to use

- Clone this repo.

- `npm i` or `yarn` to install dependencies

- `npm run dev` to start compilation in watch mode.

## Manually installing the plugin

- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/obsidian-markdown-headings/`.