Crate cargo_doc_docusaurus

Crate cargo_doc_docusaurus 

Source
Expand description

Convert rustdoc JSON output to Docusaurus-compatible markdown documentation.

This library provides functionality to parse rustdoc’s JSON output and convert it to well-formatted markdown files with React component integration for Docusaurus sites.

§Example

use cargo_doc_docusaurus::{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,
    base_path: "",
    workspace_crates: &[],
    sidebarconfig_collapsed: false,
    sidebar_output: None,
    sidebar_root_link: None,
};

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§

ConversionOptions
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.