a to z

a to z

English | 한국어

한국어 사용 설명서: atoz-docs.vercel.app

a to z is an Obsidian plugin designed to streamline writing workflows, with particular support for Korean users.

It brings frequently used editing actions, source-linked Later notes, note versions, frontmatter and topic management, note info, snippets, symbol input, and a sleep log together as commands and settings.

Features

The plugin automatically uses Korean UI text when Obsidian's interface language is Korean. All other interface languages use English.

Installation

Community plugins

Once the plugin is available in the Obsidian Community directory:

1. Open Settings → Community plugins.
2. Search for a to z.
3. Select Install, then enable the plugin.

Manual installation

1. Download or clone this repository.
2. Install the dependencies.

npm install

3. Build the plugin.

npm run build

4. Create the following folder inside your vault:

<your-vault>/.obsidian/plugins/atoz/

5. Copy these files into the folder:

manifest.json
main.js
styles.css

6. Reload Obsidian and enable a to z under Settings → Community plugins.

The minimum supported Obsidian version is 1.13.0. The plugin supports both desktop and mobile.

Recommended initial settings

After enabling the plugin, open Settings → a to z and configure only the features you need.

Use Reset all settings to restore these defaults.

Common workflows

Save text for Later

1. Select text in a regular note or work.md, or place the cursor on a line.
2. Run Later: Send selection or current line.
3. The content is saved in <source-name>_later.md and removed from the source note.
4. Select an entry in the later sidebar to move it back to the source note.

Each Later note is linked to its source by the later: "[[Source note]]" property.

Save and compare versions

1. Run Version: Save current state in a note. A version note named <number>_<timestamp> is created with a version property that links back to the source.
2. Run Version: Revert to saved version to replace the note body with a saved version. The current frontmatter is kept.
3. Run Version: Open comparison view to see what changed between two points: saved versions, the current note, or an empty note. Changes are highlighted down to the word, and moved paragraphs are marked. Version names can be changed from the comparison view.

Keep note lists

Set notelist: true in a note's frontmatter. The plugin fills the note body with a - [[link]] list of every note that links to it, sorted by name. Lists refresh when Obsidian starts and when you run Note list: Refresh all. Notes whose body contains anything other than such a list are skipped, so hand-written content is never overwritten.

Log sleep with Daynight

Open the Daynight sidebar from the moon ribbon icon or the Daynight: Open sidebar command. Press the button at the bottom to record Sleep now or Wake up now. Records are appended to a monthly sleep-YYYY-MM.md table. The sidebar shows the current state, a 24-hour chart that steps through sleep periods with ‹ and ›, and the most recent records (four by default, adjustable in settings). Only the last record can be edited or deleted, so sleep and wake records always alternate.

Clean up frontmatter

Clean up properties in entire vault checks Markdown files in the vault against the supported property list:

date:
topics:
title:
description:
cssclasses:
aliases:
tags:
later:
target-characters:
target-tolerance:
min-characters:
max-characters:
version:
notelist:

Unsupported empty properties are removed automatically. Files containing unsupported properties with values are opened in new tabs for review. log.md and the configured work note are excluded.

Insert snippets and symbols

By default, type @ followed by a search term to open snippet suggestions. Selecting an existing snippet replaces the typed range. A new snippet can be added directly from the suggestion list.

Type ~ followed by a symbol ID to open symbol suggestions. A symbol with a closing character wraps selected text, or inserts the pair and places the cursor between them. Pressing Backspace between a matching pair deletes both characters.

Commands

Ribbon icons provide quick access to the work note, mobile toolbar, Later sidebar, bookmarking the active tab, quick slots 1–4, note info, and the Daynight sidebar.

Documentation

Detailed feature documentation is available in Korean at atoz-docs (source):

Credits

The snippet and symbol suggestions include code adapted from slash-snippets-plugin by Saurav, used under the MIT License. See THIRD_PARTY_NOTICES.md for the full license text.

Support

If this plugin helps your writing, you can support its development on Buy Me a Coffee.

Development

Source files are located in src/. The build output is generated as main.js in the repository root.

npm run dev

Starts esbuild in watch mode with src/main.ts as the entry point and generates a source-mapped main.js.

npm run build

Runs the TypeScript type check and creates a production bundle.

npm run lint

Checks the project with ESLint and the recommended Obsidian plugin rules.

npm run version

Runs version-bump.mjs, then stages manifest.json and versions.json.

npm run release

Interactively shows the latest release tag and commits since that tag, then offers major, minor, and patch version choices. After confirmation, it verifies a clean main branch and the remote state, updates all version metadata, runs lint and build checks, creates the release commit and tag, and atomically pushes both main and the tag. The existing GitHub Actions workflow then builds, attests, and publishes the release. Commit the release script itself before using it for the first time.

The script also checks the documentation repository at ../atoz-docs: it must be on a clean main branch that is not behind origin/main. Documentation commits since the last release are listed, and if there are none, the script asks again before continuing. After the plugin is pushed, the same version tag is added to the documentation repository and pushed along with its main.

Project structure

.
├── manifest.json        # Obsidian plugin metadata
├── main.js              # Bundle generated by esbuild
├── styles.css           # Plugin styles
└── src/
    ├── locales/         # English and Korean UI text
    ├── main.ts          # Plugin loading, commands, and events
    ├── setting.ts       # Settings tab
    ├── types.ts         # Settings types and defaults
    ├── utils.ts         # Shared utilities
    └── features/        # Feature implementations