8000 GitHub - pmeinhardt/maxdown at wasm · GitHub
[go: up one dir, main page]

Skip to content
pmeinhardtPublic

About

for you @klappradla 👋

Topics

Resources

Stars

6 stars

Watchers

1 watching

Forks

< 8000 a data-component="Button" type="button" aria-label="Go to Tags page" href="/pmeinhardt/maxdown/tags" class="prc-Button-ButtonBase-9n-Xk Button_1__fgoRfX" data-loading="false" data-no-visuals="true" data-size="medium" data-variant="invisible">
 
 

Latest commit

 

History

43 Commits

Folders and files

Repository files navigation

Maxdown 🚲

checks

Before you get going

You will need cargo in order to build the maxdown command-line tool.

In case you are using Homebrew, it should be as easy as brew install rust.

Installation

If you use vim-plug, add this line to your Vim configuration file:

Plug 'pmeinhardt/maxdown', {'do': ':MaxdownCompile'}

If you have a different way of managing your Vim plugins, make sure you add the project directory to your runtimepath and build the command-line tool:

cargo build --release --locked

Or from within Vim:

:MaxdownCompile

Usage

The plugin does not define any mappings by default. You can invoke :MaxdownPreview from within a Markdown buffer or define a custom mapping.

For instance:

autocmd FileType markdown nnoremap <buffer> <localleader>m <Plug>MaxdownPreview

This will create a normal-mode mapping to preview the current markdown buffer.

Enhancements

When the ql Vim plugin is loaded, previews on macOS will look more neat (no [DEBUG] in the title):

Plug 'pmeinhardt/ql', {'do': ':QuickLookCompile'}

Using via WebAssembly

To compile to WebAssembly, use wasm-pack:

wasm-pack build <options> -- --features wasm

E.g. to build the web preview app, run:

wasm-pack build --target web -- --features wasm
cd web && python3 -m http.server 3000

Then:

open "http://localhost:3000/?src=https://raw.githubusercontent.com/pmeinhardt/maxdown/main/README.md"

References

About

for you @klappradla 👋

Topics

Resources

Stars

6 stars

Watchers

1 watching

Forks

Releases

Used by

Contributors

Languages

0