English | 中文

ACE CODE EDITOR

An enhanced code editor using Ace editor, providing syntax highlighting, code folding, and other advanced editing features.

Features

• Edit code directly in Obsidian

• Manage CSS snippets

• Edit code blocks

• Code file preview

Installation

Manual Installation

1. Download the latest release
2. Copy main.js, styles.css, and manifest.json to your vault's plugins folder: <vault>/.obsidian/plugins/obsidian-ace-code-editor/
3. Reload Obsidian
4. Enable the plugin in Settings → Community Plugins

BRAT (Recommended for Beta Users)

1. Install BRAT plugin
2. Click "Add Beta plugin" in BRAT settings
3. Enter RavenHogWarts/obsidian-ace-code-editor
4. Enable the plugin

Development

• Clone this repo
• Make sure your NodeJS is at least v16 (node --version)
• npm i or yarn to install dependencies
• npm run dev to start compilation in watch mode
• npm run build to build the plugin
• npm run build:local to build the plugin and copy it to your vault's plugins folder(need create a .env file in the project root and add the line: VAULT_PATH=/path/to/your/vault)
• npm run version to bump the version number and update the manifest.json, version.json, package.json
• npm run release to build the plugin and bump the version number

Support

If you encounter any issues or have suggestions:

• Open an issue on GitHub
• Join the discussion for questions and ideas
• Check the contributing guidelines if you'd like to contribute to the project

If you find this plugin helpful, you can support the development through:

• WeChat/Alipay: QR Code

License

This project is licensed under the MIT LICENSE - see the LICENSE file for details.

Star History