Skip to content

Acumane/Jotdoc

Repository files navigation


Jotdoc

A more capable, legible Markdown
Plans⠀|⠀Discussions⠀|⠀Extension⠀|⠀Downloads

💭 Motivation

Markdown intends to make ease of reading, writing, and editing prose. Its key design goal was readability—that the language be readable as-is, unencumbered by tags or formatting instructions

HTML in Markdown deteriorates readability, yet a striking number of common use cases require it 🤔

✨ Features

  • unify⠀⠀⠀ ⠀⠀ ⠀⠀⠀Unifies []() to work on text (colorize), images, and links
  • align⠀⠀⠀⠀⠀⠀⠀⠀⠀Inline and block alignment (left, center, right)
  • fracs⠀⠀⠀⠀⠀⠀⠀⠀⠀Format simple fractions
  • sub, sup⠀⠀ ⠀⠀⠀ ⠀(sub/super)script
  • comments⠀⠀ ⠀⠀⠀Block comments
  • replace⠀⠀⠀⠀ ⠀⠀⠀Inline pattern substitutions

⠀—and more are on the way! See PLANS for what's to come (still workshopping)

Support

  • vscode Extension imports Jotdoc plugins, contributes styles and syntax grammars, ㅤ and exposes plugin options in settings

🔧 Setup

This monorepo contains all Jotdoc plugins, documentation, and supporting extensions. It uses pnpm workspaces

About

A more capable, legible Markdown

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published