Docz Theme Extended

Overview

The docz-theme-extended is a theme for the docz documentation tool. It provides extended features and customization options for creating interactive and user-friendly documentation websites. This theme is licensed under MIT and welcomes contributions from all developers.

Features

• Props table: Display a table of props for components.
• Sticky headers navigation sidebar: Keep the navigation sidebar fixed while scrolling.
• Extended side menu: Allow grouping and sub-menus in the side menu.
• Footer navigation: Provide navigation links to the previous and next documents.
• Optional fixed header: Choose to have a fixed header for better navigation.
• Custom header logo: Add your own logo to the header.
• Optional extended search: Enable search functionality with the ability to search by tags.
• Custom components: Use custom components like Tabs, Tag, Hint, InlineCode, etc.

Installation

To install the docz-theme-extended, follow the steps below:

1. Make sure you have docz installed globally by running npm install -g docz.
2. Create a new docz project or navigate to your existing docz project.
3. Install the theme package by running npm install docz-theme-extended.
4. In your project’s doczrc.js file, add the following code:

export default {
  theme: 'docz-theme-extended',
  // Other config options...
}

5. Start the docz development server by running docz dev.
6. Open your browser and navigate to http://localhost:3000 to see the documentation with the extended theme.

For more information on using themes with docz, refer to the official Gatsby documentation.

Summary

The docz-theme-extended is a powerful theme for docz that offers enhanced features for creating comprehensive and visually appealing documentation websites. With customizable options, such as a sticky navigation sidebar, extended side menu, and custom components, this theme provides an excellent user experience. Its installation is straightforward, and it is open to contributions from developers. Whether you are documenting a library or a project, the docz-theme-extended can help you create an interactive and engaging documentation website.