Skip to content

Latest commit

 

History

History
52 lines (32 loc) · 986 Bytes

README.md

File metadata and controls

52 lines (32 loc) · 986 Bytes

svrx-plugin-markdown

svrx plugin for markdown, help us editing markdown like a ninja .

Usage

please confirm you have installed svrx already

npm i @svrx/cli -g

Feature

  • Don't rely on special editors.
  • Hot reload when file changes (not full render)
  • Auto jump to the file you are editing
  • Auto scroll to the area you are editing
  • Two builtin theme light and dark, follow github markdown syntax highlighter

Via CLI

svrx --markdown

or

svrx -p markdown?theme=light

Via API

const svrx = require('@svrx/svrx');

svrx({ plugins: [ 'markdown' ] }).start();

Options

  • theme: string, default is dark, you can also use light to switch light mode.
  • auto: boolean, auto jump to the markdown you are editing. default is true

License

MIT