Skip to content

Repository files navigation

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

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";

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

See Create your first editor for the full setup guide.

License

Contributing

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

Contributors

  • Maintainers

  • Contributors

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

About

A headless, modular and extensible Markdown editor built with CodeMirror 6.

Topics

Resources

Code of conduct

Contributing

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages