Skip to content

libukai/mkdocs-preview

Repository files navigation

MkDocs Preview

A lightweight VS Code extension that provides live preview of MkDocs documentation using the built-in Simple Browser. Perfect for writers and developers who want to see their documentation changes in real-time without leaving the editor.

Screenshot

preview

Command

There is one command:

  • MkDocs Preview: Toggle MkDocs Preview

Configuration

  • mkdocsPreview.autoStart: Start MkDocs server when open workspace, default is false.
  • mkdocsPreview.port: MkDocs server port, default is 4001.
  • mkdocsPreview.baseDir: MkDocs docs folder, relative path to current workspace, default is empty.
  • mkdocsPreview.urlReplace: Custom URL replacement rules. Each line represents a rule in the format 'search||replace', default is empty string.

Bugs

If you found any bugs, please open an issue.

Enjoy!

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •