cargo-readme
liscopridge
Our great sponsors
| cargo-readme | liscopridge | |
|---|---|---|
| 5 | 1 | |
| 337 | 0 | |
| - | - | |
| 5.5 | 6.7 | |
| 26 days ago | 26 days ago | |
| Rust | Python | |
| GNU General Public License v3.0 or later | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
cargo-readme
-
List of all third-party cargo subcommands
There’s also this cargo-readme
-
rustdoc comments to markdown?
cargo readme does this (specifically for crate-level documentation), not sure if that’s helpful for your usecase :)
-
Markdown Bakery - Ease maintenance of examples in your MD files
Link in case it's not just me that want aware of it.
-
I'd like to review your README
The README.md isn't part of the rust code, so it's not checked by this unless you use tools to generate your README from doc comments like https://github.com/livioribeiro/cargo-readme.
-
Hey Rustaceans! Got an easy question? Ask here (1/2021)!
I find myself repeating myself between crate-level doc comments and README files. What are people using to avoid that? cargo-readme + a CI hook?
liscopridge
-
I'd like to review your README
I've been using https://github.com/brodie/cram for this. It's a neat little shell testing tool that can be told to check that every 4-space indented markdown code block output what it says it outputs, so I just cram my README.md.
An example of this in action: https://github.com/liskin/liscopridge/blame/68a656b7beb10a5c..., https://github.com/liskin/liscopridge/blob/68a656b7beb10a5cd...
What are some alternatives?
docs.rs - crates.io documentation generator
lazy-static.rs - A small macro for defining lazy evaluated static variables in Rust.
mysql_async - Asyncronous Rust Mysql driver based on Tokio.
cram - Functional tests for command line applications
go-concise-encoding - Golang implementation of Concise Binary and Text Encoding
server - :desktop_computer: Simple and powerful server for Node.js
containers - My attempt at reimplementing some of the rust standard containers, starting with a doubly linked list
nushell - A new type of shell
rust - Empowering everyone to build reliable and efficient software.
md-bakery - CLI tool to bake your fresh and hot MD files