Header Adjuster

Heading Adjuster Plugin for Obsidian

Overview

The Heading Adjuster Plugin for Obsidian allows users to easily adjust the levels of headings in their Markdown documents. Users can increase or decrease heading levels by a specified number of levels, across the entire document, a selection, a specified range of lines, a range pinned to the cursor, or just the line the cursor is on. The plugin also provides convenient default settings for heading adjustments.

Features

• Increase heading levels by a specified number.
• Decrease heading levels by a specified number.
• Adjust headings within a specified range of lines, or across the selection.
• Adjust everything after the cursor, or everything before it, on one hotkey.
• Adjust just the line the cursor is on, including turning a plain line into a heading and back again.
• Make the current line a parent, a sibling or a child of the heading above it, put it at the top level, or remove its heading outright.
• Convert headings pushed past the deepest allowed level into bulleted list items, and optionally convert them back on the way out.
• Use default settings for heading adjustments.
• Commands accessible from the command palette.
• Ribbon icon with options for increasing or decreasing heading levels.

Installation

From inside Obsidian: open Settings → Community plugins, browse for "Heading Adjuster", and install it.

Manually:

1. Download main.js, manifest.json, and styles.css from the latest release.
2. Place all three in your vault's .obsidian/plugins/header-adjuster directory — the folder name has to match the plugin id in manifest.json, which is still header-adjuster from before the plugin was renamed.
3. Enable Heading Adjuster from Settings → Community plugins.

Usage

Commands

The plugin provides the following commands accessible from the command palette. The two "by N" commands name your current default, so N is whatever the settings say.

• Increase heading level... / Decrease heading level...: Opens a dialog asking how many levels to shift by, and optionally over which line range.
• Increase heading level by N (entire document) / Decrease heading level by N (entire document): Shifts every heading in the note by the default.
• Increase heading level by N (custom range) / Decrease heading level by N (custom range): Shifts the headings between two boundaries you set once in the settings, with no dialog and nothing selected. This is how you shift everything after the cursor, or everything before it, on a single hotkey. See The custom range below.
• Increase heading level in selection by N / Decrease heading level in selection by N: Shifts only the headings inside the current selection. Available when something is selected.
• Increase heading level of current line by N / Decrease heading level of current line by N: Shifts the line the cursor is on, and nothing else. See The current line below.
• Toggle heading on current line: Puts a heading on the current line at the level of the heading above, or takes it off again if it is already there. One binding for both halves — see Toggling below.
• Remove heading from current line: Turns the current line back into plain text, whatever level it was at.
• Make current line a top-level heading: Sets the current line to #, whatever sits above it.
• Make current line a parent of the heading above: Sets the current line one level shallower than the nearest heading above it, so that heading ends up inside the new one.
• Make current line a sibling of the heading above: Sets the current line to the level of the nearest heading above it.
• Make current line a child of the heading above: Sets the current line one level deeper than the nearest heading above it.

Each of those four is its own command, so you never have to choose one direction over another in the settings — bind the ones you use and leave the toggle for whichever you want on a single key.

Ribbon Icon

Clicking the ribbon icon opens a menu with options to:

• Increase or decrease by a number you type, over an optional line range.
• Increase or decrease the whole document by one level.
• Increase or decrease the selection by your default.
• Increase or decrease your custom range by your default.
• Increase or decrease the current line by your default.
• Remove the current line's heading, or place it at the top level or as a parent, sibling or child of the heading above.

On Mobile

Obsidian's mobile toolbar shows commands as icons with no names, so every command this plugin registers carries its own symbol and no two are alike:

Up increases and down decreases throughout, so there are two things to learn rather than sixteen. The two turning arrows are mirrors of one another, for the same reason: parent and child are one step in opposite directions.

If you only have one slot, spend it on the hash: "Toggle heading on current line" both makes a section and unmakes it.

To add one: Settings → Toolbar, then pick the commands you want. The ribbon menu shows the same symbols beside their names, which is the quickest way to learn which is which.

Modal Input

When using the "Increase heading level..." or "Decrease heading level..." commands, a dialog will prompt you to:

1. Enter the number of levels to increase or decrease (or leave blank to use the default setting).
2. Optionally specify the start line number.
3. Optionally specify the end line number.

The current line

The current-line commands are the finest of the three scopes, and the only ones that treat a line with no # as a heading of level zero. That makes them a way to write a heading as well as to move one:

So a plain line becomes a heading by increasing it once, and again for each level deeper you want. Decreasing an # takes the heading back off.

Unlike the document and selection commands, these leave nesting alone: only the line you are on moves, and headings nested under it stay where they are. If you want a heading and everything beneath it to move together, select those lines and use the selection commands. Conversions do not apply either — a line is not a section, so there is no body to indent into a bullet. A line inside a code fence is left as the code it is.

Placing a line instead of shifting it

The placement commands say what the line should be rather than how far to move it, so they land in one step and ignore your default shift. Three of them read the nearest heading above the current line:

# Guide
## Setup
### Prerequisites
some prose        ← cursor here; the heading above is `### Prerequisites`

They work on a line that is already a heading too, which is how you re-level one without counting: put the cursor on it and make it a child of the heading above. Because none of them reads the level the line is written at, the same command lands in the same place whether the line was plain text, an # or an ###### — so it is one repeatable step rather than a count-and-adjust.

Parent is the one that changes the outline around it. Where sibling and child join the section above, a parent encloses it:

# Guide            # Guide
## Setup     →     ## Setup
### Notes          ## some prose      ← `### Notes` is now inside this
some prose

That is how you open a section above work you have already written, which is the direction an outline is read in but rarely the one it gets typed in.

If there is no heading above the line, "parent", "sibling" and "child" all produce an # — the note itself is what encloses the line. A parent of an # is an # too, since nothing in an outline sits above the top of it. A heading inside a code fence does not count as the heading above, and a line inside one is left alone.

Toggling

"Toggle heading on current line" is the sibling placement and the removal in one command, which is what you want if you have a single hotkey or a single free slot on the mobile toolbar to spend:

# Guide
## Setup
some prose        ← cursor here

Which of the four it uses is yours to set, under Toggle puts the heading at in the settings. It ships as "same level as the heading above". This only decides where the one toggle aims: all four have commands of their own, so setting it never puts a level out of reach.

A heading already at some other level is moved to the one you chose rather than removed, so the second press is what takes it off. That keeps two presses enough to reach plain text from anywhere, and keeps a press from ever destroying a level you would have to retype. It also means the toggle only takes off the level it puts on: set to "one below", it will move a sibling heading rather than remove it.

Lines that are already bullets

A line cannot be a bullet and a heading at once, so writing a heading onto a list item replaces its marker instead of sitting in front of it — indentation included, since a heading only counts at the start of a line:

Ordered items are left alone: 1. is not a bullet, and the plugin keeps one definition of a list item across every command. Removing a heading never writes a bullet back, either — Markdown records no provenance for the marker it replaced, so there is nothing to restore.

Crossing between a heading and a list item

A list item holds whatever is indented past it; a heading holds whatever follows it until the next heading. They disagree about what sits underneath, so a line that stops being one and starts being the other leaves its content answering to nothing.

Turning a list item into a heading — with "Toggle heading" or any of the four placement commands — brings the items nested under it along, by as much as the item itself lost:

- A                    - A
  - B                    - B
    - C                    - C
      - D    ← caret    # D
        - E              - E
          - etc            - etc

Left where they were, those children sit at an indent nothing encloses any more — which CommonMark reads as a code block rather than a list. Bring nested list items along is on by default for that reason; switch it off to write only the line the caret is on.

The block ends at the first line indented no further than the item itself, so a sibling further down and everything under it stay put. A blank line does not end it. A line that is not a list item has nothing nested to carry, so a paragraph turned into a heading is written on its own.

Removing a heading goes the other way, and ships doing what it always did: writing the text on its own. Removing a heading leaves can instead put the line back in a list, either on its own or carrying the section the heading held:

The section ends where the heading's does — at the next heading, whatever its level. It moves as one block, so its own nesting is untouched, and it moves by one level in whatever the section already indents by: a tab-nested list gets a tab, a four-space one gets four spaces. A section with no nesting to go on takes the width of the marker instead.

The round trip does not close on depth: a heading remembers nothing about how far the item it came from was indented, so an item lifted out of four levels of nesting comes back at the top level. Markdown records no provenance for that, which is the same limit ADR-0001 describes.

The custom range

The five other scopes each name their range in their own command name, which is what makes them safe to bind: the hotkey does what the palette said it would. The custom range is the one whose boundaries you choose, and it is there for the range you want that the plugin does not ship — most often everything after the cursor, when a note has been pasted into the middle of another and needs pushing a level deeper.

Two settings pick its boundaries — a top and a bottom, each naming the place it sits on:

The top offers only the start of the note or the cursor, and the bottom only the cursor or the end, so there is no way to set a range that runs backwards.

The cursor's own line is always inside the range. Standing on ## Section with the top set to the cursor line and shifting down moves that heading too, along with everything under it.

Both boundaries default to the note's own edges, so before you touch them the custom commands are a second copy of the document commands rather than a surprise. A boundary changed mid-session takes effect immediately — there is no reload.

Line numbers are deliberately not offered here. A range baked into a hotkey outlives the note it was set for; for a one-off range, use Increase heading level... and type it.

Settings

Access the plugin settings from the Obsidian Settings under the "Heading Adjuster" section. They are grouped by the commands they govern — Default shift, Custom range, Toggle heading on current line, and Bullet conversion:

• Default increase level: The default number of levels to increase headings by.
• Default decrease level: The default number of levels to decrease headings by.
• Toggle puts the heading at: Which level "Toggle heading on current line" writes, and so which level it takes back off — the top level (#), one level above the heading above, the same level as it, or one below it. Defaults to the same level. Each of the four is also a command in its own right, so this only decides where the one toggle aims.
• Bring nested list items along: When a placement turns a list item into a heading, move the items nested under it out by as much as it lost. On by default — see Crossing between a heading and a list item.
• Removing a heading leaves: What "Remove heading from current line", and a toggle switching one off, writes in its place — plain text (the default), a list item, or a list item with the heading's section nested under it.
• Custom range: top: Where the two "custom range" commands start — the top of the note, or the cursor line. See The custom range.
• Custom range: bottom: Where the same two commands stop — the cursor line, or the end of the note.
• Deepest heading level: The level headings stop at. Anything an increase would push past it becomes a bulleted list item instead, and a bullet converted back returns to this level. Only has an effect with a conversion below switched on.
• Convert headings past the deepest level into bullets: When increasing would push a heading past the level above, turn it into a bulleted list item instead of leaving it unchanged. The content beneath the heading is re-indented so it sits inside the new bullet.
• Convert bullets back into headings: When decreasing, turn list items back into headings. This cannot tell a bullet the plugin created from one you typed yourself, so every list in range is converted — hand-written ones included. An item takes one decrease per level of nesting to reach a heading, so a heading that overflowed several levels past the ceiling needs the same number of decreases to come back.

Example Usage

Full Document Adjustment

To increase all headings in a document by 2 levels:

1. Open the command palette (Ctrl+P or Cmd+P).
2. Select "Increase heading level...".
3. Enter 2 in the modal and click "Submit".

Range Adjustment

To decrease headings from line 5 to line 20 by 1 level:

1. Open the command palette (Ctrl+P or Cmd+P).
2. Select "Decrease heading level...".
3. Enter 1 in the modal.
4. Enter 5 for the start line.
5. Enter 20 for the end line.
6. Click "Submit".

Using Default Settings

To increase every heading in the note using the default setting:

1. Open the command palette (Ctrl+P or Cmd+P).
2. Select "Increase heading level by N (entire document)".

To do the same to a selection, select the lines first and run "Increase heading level in selection by N".

Promoting One Line to a Heading

To turn the paragraph you are looking at into an ### heading:

1. Put the cursor anywhere on the line.
2. Run "Increase heading level of current line by N" three times, with the default set to 1.

To take it back off, run "Remove heading from current line" once, or "Decrease heading level of current line by N" until the # characters are gone.

Filing a Line Under the Section It Is In

To turn a line into a subheading of whatever section it already sits in:

1. Put the cursor anywhere on the line.
2. Run "Make current line a child of the heading above".

The level is worked out from the note, so this does the right thing whether the section above is an # or an #####.

Development

See CONTRIBUTING.md for setup, the checks a change has to pass, and where each kind of code belongs. docs/architecture.md describes the layering, and CONTEXT.md defines the vocabulary the code is written in.

License

This plugin is licensed under the MIT License.