@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

@docusaurus/plugin-content-docs

Docs plugin for Docusaurus.

Usage

See plugin-content-docs documentation.

Changelog

3.7.0 (2025-01-03)

:rocket: New Feature

• docusaurus-faster, docusaurus
  • #10800 feat(core): Turn Rspack incremental on by default (again) (@slorber)
• docusaurus-plugin-content-blog, docusaurus-theme-classic
  • #10768 feat(blog): Add author social icons for bluesky, mastodon, threads, twitch, youtube, instagram (@GingerGeek)
• create-docusaurus, docusaurus-mdx-loader, docusaurus-module-type-aliases, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-debug, docusaurus-plugin-google-analytics, docusaurus-plugin-google-gtag, docusaurus-plugin-google-tag-manager, docusaurus-plugin-ideal-image, docusaurus-plugin-pwa, docusaurus-plugin-rsdoctor, docusaurus-plugin-sitemap, docusaurus-plugin-svgr, docusaurus-plugin-vercel-analytics, docusaurus-preset-classic, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-theme-mermaid, docusaurus-theme-search-algolia, docusaurus-types, docusaurus
  • #10763 feat: Add React 19 support to Docusaurus v3 (@slorber)
• docusaurus-plugin-content-blog
  • #10729 feat(blog): Add frontMatter.sidebar_label (@slorber)
• docusaurus-module-type-aliases, docusaurus-plugin-svgr, docusaurus-preset-classic, docusaurus-types, docusaurus-utils, docusaurus
  • #10677 feat(svgr): create new Docusaurus SVGR plugin (@slorber)

:bug: Bug Fix

• docusaurus-remark-plugin-npm2yarn
  • #10803 fix(npm-to-yarn): add missing npm-to-yarn converter for Bun (@Lehoczky)
• docusaurus-theme-classic, docusaurus-theme-common
  • #10796 fix(theme): Footer Column/Link should merge provided className (@slorber)
• docusaurus-bundler, docusaurus-theme-common
  • #10786 fix(core): fix React hydration errors, change html minifier settings (@slorber)
• docusaurus-theme-common
  • #10782 fix(theme-common): code block magic comments should support SQL block comments (@WillBlack403)
• docusaurus-theme-translations
  • #10783 fix(theme-translations): Add missing Dutch (nl) theme translations (@janaukema)
  • #10760 fix(theme-translation): add missing Korean (ko) theme translations (@effozen)
• docusaurus-plugin-content-docs
  • #10754 fix(docs): fix sidebar item visibility bug for category index (@slorber)
• docusaurus
  • #10727 fix(core): fix codegen routesChunkName possible hash collision (@slorber)
• docusaurus-mdx-loader
  • #10723 fix(mdx-loader): fix md image paths with spaces bug related to transformImage encoding problem (@slorber)

:memo: Documentation

• #10740 docs: Link initialization docs together (@waldyrious)

:robot: Dependencies

• #10771 chore(deps): bump nanoid from 3.3.7 to 3.3.8 (@dependabot[bot])
• #10721 chore(deps): bump actions/dependency-review-action from 4.4.0 to 4.5.0 (@dependabot[bot])

:wrench: Maintenance

• Other
  • #10770 chore: Devcontainer upgrade to Ubuntu Noble & Node 22 (@GingerGeek)
• docusaurus-theme-search-algolia
  • #10801 refactor(algolia): simplify SearchBar component (@slorber)
  • #10672 chore(algolia): upgrade algoliasearch to v5 (@millotp)
• docusaurus
  • #10798 refactor(core): Use Intl native API to get locale direction, remove rtl-detect depend… (@slorber)
  • #10747 refactor(core): swizzle wrap should use ReactNode instead of JSX.Element (@slorber)
• create-docusaurus, docusaurus-mdx-loader, docusaurus-module-type-aliases, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-debug, docusaurus-plugin-ideal-image, docusaurus-plugin-pwa, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-theme-mermaid, docusaurus-theme-search-algolia, docusaurus-types, docusaurus
  • #10746 refactor: prepare types for React 19 (@slorber)
• docusaurus-theme-common
  • #10728 refactor(theme-common): change storageUtils useSyncExternalCode getSnapshot workaround (@slorber)

Committers: 14

• Alvin Bryan (@alvinometric)
• Hichem Fantar (@hichemfantar)
• Ivan Cheban (@ivancheban)
• Jake Boone (@jakeboone02)
• Jan Aukema (@janaukema)
• Lehoczky Zoltán (@Lehoczky)
• Lin Huang (@codimiracle)
• Pierre Millot (@millotp)
• Sébastien Lorber (@slorber)
• Taylor Reece (@taylorreece)
• Waldir Pimenta (@waldyrious)
• William Black (@WillBlack403)
• Zed Spencer-Milnes (@GingerGeek)
• Zen (@effozen)