@docusaurus/plugin-content-docs

What is @docusaurus/plugin-content-docs?

@docusaurus/plugin-content-docs is a Docusaurus plugin that allows you to create and manage documentation pages. It provides features for organizing, versioning, and customizing your documentation content.

What are @docusaurus/plugin-content-docs's main functionalities?

Creating Documentation Pages

This feature allows you to create and manage individual documentation pages. Each page can have an ID, title, and content.

{"docs":[{"id":"intro","title":"Introduction","content":"Welcome to the documentation!"},{"id":"setup","title":"Setup","content":"Here is how you set up the project."}]}

Versioning

This feature allows you to manage different versions of your documentation. You can enable versioning and specify different versions with labels and paths.

{"versioning":{"enabled":true,"versions":[{"label":"1.0.0","path":"1.0.0"},{"label":"2.0.0","path":"2.0.0"}]}}

Sidebar Configuration

This feature allows you to configure the sidebar for your documentation. You can organize your documentation into categories and specify the items under each category.

{"sidebar":{"docs":[{"type":"category","label":"Getting Started","items":["intro","setup"]},{"type":"category","label":"Advanced","items":["advanced-setup","advanced-usage"]}]}}

Other packages similar to @docusaurus/plugin-content-docs

vuepress

VuePress is a static site generator powered by Vue.js. It is similar to @docusaurus/plugin-content-docs in that it allows you to create and manage documentation pages, but it is built on Vue.js instead of React.

mkdocs

MkDocs is a static site generator that's geared towards project documentation. It uses Markdown for writing content and YAML for configuration. Unlike @docusaurus/plugin-content-docs, which is React-based, MkDocs is Python-based.

docsify

Docsify generates documentation websites on the fly. It does not require a static site generator and is very lightweight. Unlike @docusaurus/plugin-content-docs, which pre-builds the site, Docsify renders the documentation dynamically in the browser.

README

The README file is missing

Changelog

2.0.0-alpha.31 (2019-10-26)

• Footer is now sticky/ pinned to the bottom of the viewport in desktop browsers.
• Footer is now also displayed in docs page for consistency.
• Remove empty doc sidebar container if sidebar for a particular doc page does not exist. Otherwise, it will cause an additional empty space.
• Default PostCSS loader now only polyfills stage 3+ features (previously it was stage 2) like Create React App. Stage 2 CSS is considered relatively unstable and subject to change while Stage 3 features will likely become a standard.
• Fix search bar focus bug. When you put the focus on search input, previously the focus will remain although we have clicked to other area outside of the search input.
• New themeConfig option sidebarCollapsible. It is on by default. If explicitly set to false, all doc items in sidebar is expanded. Otherwise, it will still be a collapsible sidebar.
• Disable adding hashes to the generated class names of CSS modules in dev mode. Generating unique identifiers takes some time, which can be saved since including paths to files in class names is enough to avoid collisions.
• Fix showing sidebar category with empty items.
• Update infima from 0.2.0-alpha.2 to 0.2.0-alpha.3
  • Fix pagination nav and right sidebar color contrast ratio
  • Fix sidebar arrow color in dark mode
  • Fix footer mobile issue
  • Increase sidebar width
  • etc