![]() |
Pavus is the next-generation markdown tool. Need to preview your markdown? Need templates for your README? It got your back! Getting started •
Installation •
Configuration •
Pix me a coffee
|
- Pleasant DX: intuitive, descriptive messages and colorful outputs
- Preview your markdown with hot reloading out-of-the-box
- Just a single lightweight binary with all the batteries included
Important
Work in progress... Just wait!
Like in Ruke, here you will find all about the command-line interface (available commands, descriptions, flags and aliases).
A list of the features I want to implement, this should serve as a guide during development.
- Markdown preview
-
pavus
orpavus path/to.md
- Rendering (markdown to html, markdown-it)
- Hot reloading (gorilla/websocket)
- Syntax highlighting (shiki)
- LaTeX (KaTeX?) and Mermaidjs
- Images
- Default theme
-
- Markdown templates
-
init
orinit --template "x"
- create markdown with a template and generate prompts to fill it (interactive) -
add
oradd section
- append section (add at the end, interactive, available sections should be documented)
-
- Configuration
- Markdown + AI
- Fill template gaps
Feel free to contribute, opening an issue to report a bug, suggest a CLI change, an improvement or a feature.
- Fork this repository
- Clone your fork on your machine
- Make your changes, commit and push them
- Open a pull request (write a descriptive message about what you changed)
This project is licensed under the MIT License - See the LICENSE for more information.
If this project helped you, consider to pix me a coffee! 💜 🇧🇷