inksane

a extendable markdown rich-text like editor inspired by Obsidian

Warning: This repo is still very early in development and far from a first release. If you want to help, feel free to contribute.

Check out the demo to see the editor in action.

Documentation

The documentation site lives in apps/docs. It is built with Astro and Fumadocs, and is published at https://bdbch.github.io/inksane/docs/.

Run it locally:

pnpm dev:docs

The content is written in Markdown and MDX under apps/docs/content/docs.

Getting Started

Install the core package:

pnpm install @inksane/core

Add an empty element to your page:

<div id="editor"></div>

Then create and mount the editor:

import { Editor } from "@inksane/core";
import { BaseKit } from "@inksane/core/extensions/base-kit";

new Editor({
  element: document.getElementById("editor"),
  content: "# Hello, inksane!",
  extensions: [BaseKit()],
});

BaseKit adds the standard Markdown features, history, editing shortcuts, and placeholder support. Core does not load feature extensions automatically. You can also import individual features, such as BoldExtension from @inksane/core/extensions/bold.

See Create your first editor for the full setup guide.

License

• inksane is licensed under the MIT License.

Contributing

Contributions are welcome. Please read and follow the contributor guidelines before opening a pull request.

Contributors

• Maintainers

  • bdbch

• Contributors

  • Want to become a contributor to inksane? Go for it - I'm always looking for reoccuring contributors