Robindoc
Robindoc is a framework for automatically creating documentation websites based on markdown files, built on React.js Server Components.
/docs/page.tsx
export const Documentation = () => {
return (
<RobinProvider>
<Header logo={<Logo />} />
<Main>
<Sidebar pathname="/docs" />
<Page pathname="/docs" />
</Main>
<Footer copyright="© 2024 All rights reserved" />
</RobinProvider>
);
};
The main goal of Robindoc is to create a system where you can fully reuse the existing markdown documentation within your projects.
No additional configuration is needed, while preserving the accessibility and clarity of the original documentation.
Advantages
- Works on React.js Server Components (RSC). More details in the section "App Organization";
- Zero configuration of the project, bundler, or markdown documents. More details in the section "Customization";
- Supports loading content from various sources, including GitHub. More details in the section "Data Source";
- Supports fully automatic documentation generation, as well as custom generation. More details in the section "Structure";
- Supports JSX/HTML and special Robin components for all sources. More details in the section "Writing MD";
- Optimized for metrics and accessibility.
Additional
Please consider giving a star if you like it, it shows that the package is useful and helps me continue work on this and other packages.
Feel free to create issues with requests, ideas, difficulties, etc. All of them will definitely be considered and thought over.