Expand description
Convert rustdoc JSON output to clean, LLM-friendly markdown documentation.
This library provides functionality to parse rustdoc’s JSON output and convert it to well-formatted markdown files suitable for LLM consumption and text-based viewing.
§Example
use rustdoc_json_to_markdown::{convert_json_file, ConversionOptions};
use std::path::Path;
let options = ConversionOptions {
input_path: Path::new("target/doc/my_crate.json"),
output_dir: Path::new("docs"),
include_private: false,
};
convert_json_file(&options).expect("Conversion failed");
Re-exports§
pub use rustdoc_types;
Modules§
- converter
- Markdown converter for rustdoc JSON data.
- parser
- JSON parser for rustdoc output.
- writer
- Markdown file writer.
Structs§
- Conversion
Options - Options for converting rustdoc JSON to markdown.
Functions§
- convert_
json_ file - Convert a rustdoc JSON file to markdown (multi-file output).
- convert_
json_ string - Convert rustdoc JSON data (already loaded) to markdown.