Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/markmap/coc-markmap
https://github.com/markmap/coc-markmap
coc markmap vim
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/markmap/coc-markmap
- Owner: markmap
- License: mit
- Created: 2020-01-12T15:04:12.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-02-09T12:23:42.000Z (12 months ago)
- Last Synced: 2024-05-22T00:11:27.579Z (8 months ago)
- Topics: coc, markmap, vim
- Language: TypeScript
- Homepage: https://markmap.js.org/
- Size: 276 KB
- Stars: 206
- Watchers: 6
- Forks: 13
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# coc-markmap
Visualize your Markdown as mindmaps with [markmap](https://markmap.js.org/).
This is an extension for [coc.nvim](https://github.com/neoclide/coc.nvim).
If you prefer a CLI version, see [markmap-cli](https://github.com/gera2ld/markmap/tree/master/packages/markmap-cli).
Note: _coc-markmap_ allows generating markmaps from current buffer or selected text, while the CLI version can only create markmaps from Markdown files.
## Installation
First, make sure [coc.nvim](https://github.com/neoclide/coc.nvim) is started.
Then install with the Vim command:
```
:CocInstall coc-markmap
```
## Usage
You can run the commands below **in a buffer of Markdown file**.
### Generating a markmap HTML
```viml
:CocCommand markmap.create
```
Or inline all assets to work offline:
```viml
:CocCommand markmap.create --offline
```
**This command will create an HTML file rendering the markmap and can be easily shared.**
The HTML file will have the same basename as the Markdown file and will be opened in your default browser. If there is a selection, it will be used instead of the file content.
Transforming plugins are enabled by default, including syntax highlight with [PrismJS](https://prismjs.com/) and math typesetting with [Katex](https://katex.org/).
### Watching mode
```viml
:CocCommand markmap.watch
```
**This command will start a development server and track your cursor.**
The markmap will update once the markdown file changes, and the node under cursor will always be visible in the viewport on cursor move.
## Configurations
### CocConfig
You can change some global configurations for this extension in `coc-settings.json`.
First open the settings file with `:CocConfig`.
### Key mappings
There is no default key mapping, but you can easily add your own:
```viml
" Create markmap from the whole file
nmap m (coc-markmap-create)
" Create markmap from the selected lines
vmap m (coc-markmap-create-v)
```
### Commands
It is also possible to add a command to create markmaps.
```viml
command! -range=% Markmap CocCommand markmap.create
```
Now you have the `:Markmap` command to create a Markmap, either from the whole file or selected lines.