Trivernis
/
snekdown
mirror of https://github.com/Trivernis/snekdown.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
An extended markdown parser written in pure rust
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
221 Commits
5 Branches
16 Tags
785 KiB
Rust 96.5%
SCSS 3.4%
HTML 0.1%
 
 
 
version-2
main
develop
actions
feature/epub-rendering
v0.27.0
v0.30.1
v0.30.2
v0.30.3
v0.30.4
v0.30.5
v0.31.0
v0.31.1
v0.32.0
v0.32.1
v0.32.2
v0.33.0
v0.33.1
v0.33.2
v0.33.3
v0.33.4
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'main'
${ noResults }
Go to file
Trivernis 0f2bd16d28
Merge pull request #23 from Trivernis/develop 
Develop
 		4 years ago
.github Add fetch feature to headless_chromium dep 4 years ago
images Add snekdown logo to README 4 years ago
src Merge branch 'main' into develop 4 years ago
.gitignore Add automated parsing tests 5 years ago
Cargo.lock Bump version 4 years ago
Cargo.toml Bump version 4 years ago
LICENSE Create LICENSE 5 years ago
README.md Add chromium requirement to README 4 years ago
rust-toolchain Add build-and-release task and rust-toolchain file 4 years ago

README.md

Snekdown

More than just Markdown



Documentation | Releases

Description

This projects goal is to implement a fast markdown parser with an extended syntax fitted for my needs.

Core Features

  • Imports
  • Bibliography & Glossary
  • AsciiMath
  • Placeholders
  • Advanced Images

Prerequisites

  • Google Chrome/Chromium (for PDF rendering)

Installation

Binaries

You can download prebuilt binaries on the Releases Page.

Arch Linux

Snekdown is available in the AUR.

Cargo

You need a working rust installation, for example by using rustup.

cargo install snekdown

With pdf rendering

cargo install snekdown --features pdf

Usage

Use snekdown help and snekdown <subcommand> --help for more information.

Rendering

snekdown render <input> <output>

Watching

snekdown watch <input> <output>

Editors

I've created a VisualStudio Code extension for Snekdown. This extension provides a preview of snekdown files, exports and other commands similar to the cli. The source code can be found here.

Roadmap

The end goal is to have a markup language with features similar to LaTeX.

Short Term

  • Checkboxes
  • Emojis (:emoji:)
  • Colors
  • Watching and rendering on change
  • Metadata files
  • Bibliography
  • Math
  • Glossary
  • Chromium based pdf rendering
  • Custom Stylesheets
  • Smart arrows
  • Cross References
  • Figures
  • EPUB Rendering
  • Text sizes
  • Title pages

Long Term

  • Rewrite of the whole parsing process
  • Custom Elements via templates

License

This project is licensed under GPL 3.0. See LICENSE for more information.