convert_json_file

Function convert_json_file 

Source
pub fn convert_json_file(options: &ConversionOptions<'_>) -> Result<()>
Expand description

Convert a rustdoc JSON file to markdown (multi-file output).

This is the main entry point for library usage. Generates one file per module.

§Arguments

  • options - Configuration for the conversion

§Returns

Returns Ok(()) on success, or an error if the conversion fails.

§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: "",  // Optional: use "/docs/runtime/rust" for Docusaurus routing
    workspace_crates: &[],
    sidebarconfig_collapsed: false,
    sidebar_output: None,
    sidebar_root_link: None,
};

convert_json_file(&options).expect("Conversion failed");