Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gera2ld/coc-reveal
Transform your Markdown to slides
https://github.com/gera2ld/coc-reveal
coc coc-extension markdown reveal-js
Last synced: 30 days ago
JSON representation
Transform your Markdown to slides
- Host: GitHub
- URL: https://github.com/gera2ld/coc-reveal
- Owner: gera2ld
- License: mit
- Created: 2021-03-17T17:06:21.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-06-15T04:17:29.000Z (over 3 years ago)
- Last Synced: 2024-10-16T21:10:55.247Z (3 months ago)
- Topics: coc, coc-extension, markdown, reveal-js
- Language: TypeScript
- Homepage:
- Size: 15.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# coc-reveal
Transform your Markdown to slides powered by [reveal.js](https://github.com/hakimel/reveal.js/).
This is an extension for [coc.nvim](https://github.com/neoclide/coc.nvim).
## Installation
First, make sure [coc.nvim](https://github.com/neoclide/coc.nvim) is started.
Then install with the Vim command:
```
:CocInstall coc-reveal
```## Usage
Open a Markdown, and execute:
```viml
:CocCommand reveal.it
```An HTML file with the same basename as the Markdown file will be created and opened in your default browser.
### Key mappings
There is no default key mapping, but you can easily add your own:
```viml
" Create slides from the whole file
nmap r (coc-reveal-it)
" Create slides from the selected lines
vmap r (coc-reveal-it-v)
```### Commands
It is also possible to add a command to create slides.
```viml
command! -range=% RevealIt CocCommand reveal.it
```Now you have the `:RevealIt` command to create slides, either from the whole file or selected lines.
### Front matter
You can change the default options in front matter:
```markdown
---
title: The title of my slides
author: Me
---
```