mirror of
https://github.com/tauri-apps/rustdocusaurus.git
synced 2026-02-04 10:41:19 +01:00
ee08f8f37ba4c8aba824884ac009c7dade062ab2
rustdocusaurus
Experiment to turn a rustdoc generated site into MDX content.
Usage
const { transformDocs } = require("./main");
const generateSidebar = require("./generateSidebar");
const fs = require("fs").promises;
const originPath = "/path/to/project/target/doc/";
const targetPath =
"/path/to/docusaurus/website/docs/api/rust/";
const sidebarPath =
"/path/to/docusaurus/website/sidebars.json";
const linksRoot = "/docs/api/rust/";
(async () => {
const sidebarItems = (
await Promise.all(
[
"crate1", // Specify which crates you want to process
"crate2",
"crate3"
].map(async (crateName) => ({
crateName,
docs: await transformDocs(
originPath + crateName,
originPath,
targetPath
),
}))
)
).map((item) => generateSidebar(item.docs, item.crateName, originPath));
// Automatically add the sidebar items to Docusaurus sidebar file config
const sidebarContent = JSON.parse(await fs.readFile(sidebarPath, "utf-8"));
sidebarContent.docs[3].items[2].items = sidebarItems; // Specify where to put the items
fs.writeFile(sidebarPath, JSON.stringify(sidebarContent, null, 2));
console.log("Tasks completed!");
})();
Description
Languages
JavaScript
100%