Skip to content

MattMangoni/typed-notes

Repository files navigation

Typed Notes

Typed Notes is an Obsidian plugin for creating, validating, and browsing typed notes using vault-native frontmatter schemas.

It brings a lightweight "type" layer to plain Markdown files: each note can declare a type, and each type defines the expected frontmatter properties, defaults, and creation template.

Features

  • Define note types as Markdown files in _types/.
  • Create typed notes from native Obsidian commands and modals.
  • Validate required properties and property kinds from frontmatter.
  • Browse available types and notes by type from sidebar views.
  • Review type issues from a dedicated sidebar view and status bar indicator.
  • Use note templates from the body of each type definition.

Type definitions

Type definitions live in _types/<Name>.md. The filename is the type name.

Example:

---
icon: folder-kanban
color: "#5b8def"
folder: Projects
properties:
  - name: status
    kind: select
    required: true
    default: active
    options:
      - active
      - paused
      - done
  - name: due
    kind: date
  - name: client
    kind: relation
---

Optional documentation about this type.

<!-- template -->

## Notes

New typed notes receive type: <Name> in frontmatter. If the type definition contains <!-- template -->, only the content below the marker is used as the new note body. If no marker is present, the whole body is used as the template.

Supported property kinds:

  • string
  • number
  • boolean
  • date
  • select
  • multi-select
  • relation

Commands

  • Create type
  • Create typed note
  • Open Typed Notes sidebar
  • Open type issues
  • Validate current file
  • Auto-fix missing required properties

Settings

Typed Notes uses _types as the default type definitions folder. You can change it from the plugin settings.

Privacy and data

Typed Notes does not use telemetry, analytics, ads, accounts, or network requests. It reads and writes Markdown files inside your Obsidian vault using Obsidian's plugin APIs.

Installation

For now, install manually by copying the release assets into:

<vault>/.obsidian/plugins/typed-notes/

Required files:

  • manifest.json
  • main.js
  • styles.css

Then reload Obsidian and enable Typed Notes from Community plugins.

Development

npm install
npm run dev
npm run build

npm run build typechecks the TypeScript source and creates the production bundle.

License

MIT

About

Typed notes for Obsidian. Define schemas in _types/ and create, validate, and browse notes by type.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors