Skip to content

Latest commit

 

History

History
30 lines (20 loc) · 1.02 KB

README.md

File metadata and controls

30 lines (20 loc) · 1.02 KB
Raw

Integrate mdbook into your JetBrains IDE.

This plugin provides essential features for working with mdBook projects directly within your IDE:

  • Live Preview: Launch and manage the mdbook serve instance for real-time previews.
  • Embedded Browser: View your beautifully rendered mdBook documentation right within the IDE.

Streamline your documentation workflow and focus on creating high-quality content with the MarkdownBook plugin.


This is the initial release. Expect UI/UX issues.


Caveats:

  • Assumes that mdbook is available on the PATH
  • Tested on Linux only so far
  • Likely many unknowns.

TODO:

  • File Watcher: Generally done, but watch also for non-obvious changes like file renames.
  • Browser State: Preserve cookies, e.g., to preserve selected theme.
  • Configuration: Allow customizing mdBook settings and parameters.
  • Autodiscovery: Automatic detection of the mdBook binary.