Crates.io | render_readme |
lib.rs | render_readme |
version | 0.15.0 |
created_at | 2022-09-03 16:21:28.147166+00 |
updated_at | 2025-06-29 23:06:02.535581+00 |
description | Render Markdown or reStructuredText with syntax highlighting and image filtering similar to GitHub's |
homepage | |
repository | https://gitlab.com/lib.rs/render_readme |
max_upload_size | |
id | 657953 |
size | 1,086,748 |
Readme to HTML conversion for lib.rs.
Supports:
rst2html
), and a tiny subset of AsciiDoc.<code>
tags, tuned for languages mentioned by Rust crates.Install docutils
package, so that rst2html
command is available (in PATH
).
It needs to write a file to system's temp directory for rst2html
. If you clear temp while the program is running, rst support may fail.
It generates HTML <span>
class names based on scope names from Sublime Syntax files, but:
highlight.rs
for the list of abbreviations.All languages are precompiled from syntaxes/
submodule.
tmLanguage
definitions need to be converted first.