✨OrgNote Extensions Collection

 

Introduction

This is the official repository for containing extensions for OrgNote application. You are free to add a new extension by creating PR.

WARNING *OrgNote is currently in the beta stage. API may be changed in the future*

Connected links

• Official website
• Org Note client
• Typescript abstract syntax tree for org mode.
• Discord server
• NPM package for creating your own extension

Contribution guide

• Fork repository.
• Create new .toml file in the recipes folder.

Recipe format (TOML)

# Extension description comment
name = "My Extension"
version = "1.0.0"
category = "theme"  # theme | extension | language pack | other
description = "Short description of your extension"
author = "your-username"
keywords = ["keyword1", "keyword2"]

# Optional fields
apiVersion = "0.13.4"  # OrgNote API version
readmeFilePath = "README.org"  # Default: README.org
reloadRequired = false
development = false
icon = "path/to/icon.png"
permissions = ["files", "personal info"]  # files | personal info | * | third party
sponsor = ["https://patreon.com/you"]

[source]
type = "git"
repo = "https://github.com/username/extension-repo"
# branch = "main"  # Optional: specific branch
# tag = "v1.0.0"   # Optional: specific tag

Example recipe

# Atom One Dark theme for OrgNote
name = "Atom One Dark Theme"
version = "0.0.1"
category = "theme"
description = "Atom One Dark theme for OrgNote!"
keywords = ["ui", "theme", "dark"]
apiVersion = "0.13.4"

[source]
type = "git"
repo = "https://github.com/artawower/orgnote-atom-one-dark"

TypeScript type reference

interface ExtensionManifest {
  name: string;
  version: string;
  category: 'theme' | 'extension' | 'language pack' | 'other';
  source: GitSource | LocalSource;

  author?: string;
  description?: string;
  keywords?: string[];
  icon?: string;
  platforms?: Platform[];
  permissions?: Array<'files' | 'personal info' | '*' | 'third party'>;

  apiVersion?: string;
  minOrgNoteVersion?: string;

  license?: string;
  sponsor?: string[];

  readmeFilePath?: string;

  reloadRequired?: boolean;
  development?: boolean;

  commands?: Command[];
  keybindings?: Keybinding[];

  activationEvents?: Array<'onStartup' | '*'>;

  dependencies?: Record<string, string>;

  configSchema?: ConfigSchema;
}

interface GitSource {
  type: 'git';
  repo: string;
  branch?: string;
  tag?: string;
}

interface LocalSource {
  type: 'local';
}

See more examples in the recipes directory.

How to update version of the application

./update-version.sh