lmake_cargo_toml_to_md

Crates.iolmake_cargo_toml_to_md
lib.rslmake_cargo_toml_to_md
version2020.1209.1045
sourcesrc
created_at2020-07-15 16:15:12.174732
updated_at2021-08-14 11:04:33.651182
descriptionIncludes Cargo.toml data into md.
homepage
repositoryhttps://github.com/LucianoBestia/lmake_cargo_toml_to_md
max_upload_size
id265496
size24,287
bestia.dev (bestia-dev)

documentation

README

lmake_cargo_toml_to_md

­čö┤OBSOLETE, ­čö┤DEPRECATED, ­čö┤DEFUNCT!
It was replaced by the crate cargo-auto




Includes Cargo.toml data into md.
repo; version: 2020.1209.1044 date: 2020-12-09 authors: Luciano Bestia

Lines in Rust code Lines in Doc comments Lines in Comments Lines in examples Lines in tests

crates.io Documentation crev reviews Lib.rs Licence

Includes data from cargo.toml to md files.
To avoid out of sync data like version, authors and description.
The lmake_cargo_toml_to_md binary must be executed in the project root folder where is the cargo.toml file.
It works only for single projects and not for workspaces.

include cargo.toml data into md file

In the md file write these markers:

1 [comment]: # (lmake_cargo_toml_to_md start)
2 [comment]: # (lmake_cargo_toml_to_md end)

lmake_cargo_toml_to_md deletes the old lines between the markers
and includes the date and the cargo.toml data:
version, authors, repository and description.

Tasks in Makefile.toml

I use cargo make to script the repetitive commands sequences.
https://github.com/sagiegurari/cargo-make
In Makefile.toml add a task like this:

[tasks.doc]
description = "create docs from doc comments"
clear = true
script = [
    "lmake_cargo_toml_to_md",
    "lmake_md_to_doc_comments",
    "cargo doc --no-deps --document-private-items",
    "\\rsync -avz --delete-after target/doc/*  docs/",
]

install

Install from crates.io:
cargo install lmake_cargo_toml_to_md
Then you can use it in every rust project folder.
No arguments needed to execute the util.

Development

Documentation:
https://lucianobestia.github.io/lmake_cargo_toml_to_md/
List of prepared make tasks for development: build, run, doc, publish,...
cargo make

cargo crev reviews and advisory

It is recommended to always use cargo-crev
to verify the trustworthiness of each of your dependencies.
Please, spread this info.
On the web use this url to read crate reviews. Example:
https://web.crev.dev/rust-reviews/crate/num-traits/

Commit count: 0

cargo fmt