@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.66 (2020-10-19)

:rocket: New Feature

• docusaurus-plugin-content-blog, docusaurus-theme-classic
  • #3593 feat(v2): blog sidebar (@slorber)
• docusaurus-mdx-loader, docusaurus-remark-plugin-npm2yarn
  • #3469 feat(v2): Extract npm2yarn plugin (@fanny)
• docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-theme-search-algolia
  • #3550 feat(v2): contextual search, dynamic Algolia facetFilters (@slorber)
• docusaurus-theme-classic
  • #3580 feat(v2): allow to define custom CSS class for Tabs component (@Simek)
  • #3553 feat(v2): make dropdown menu collapsible on mobiles (@lex111)
• docusaurus-migrate, docusaurus-types, docusaurus
  • #3573 feat(v2): Add themeConfig.noIndex option #3528 (@hamzahamidi)
• docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus
  • #3543 feat(v2): persist docs preferred version (@slorber)
• docusaurus-theme-classic, docusaurus
  • #3548 feat(v2): version dropdown before/after items + move site "All Versions" link (@slorber)
• docusaurus-types, docusaurus
  • #3545 feat(v2): site client modules (@slorber)
• docusaurus-plugin-content-docs, docusaurus-theme-classic
  • #3539 feat(v2): doc navbar item type (@slorber)

:boom: Breaking Change

• docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-theme-search-algolia
  • #3550 feat(v2): contextual search, dynamic Algolia facetFilters (@slorber)

:bug: Bug Fix

• docusaurus-theme-classic, docusaurus
  • #3607 fix(v2): fix error with required href attr of link in mobiles (@lex111)
• docusaurus-theme-classic
  • #3602 fix(v2): make dropdown button clickable with mouse (@lex111)
  • #3601 fix(v2): fix table-of-content scroll highlighting issues (@slorber)
• docusaurus-theme-bootstrap, docusaurus-theme-classic
  • #3599 fix(v2): remove event listeners on Tabs component unmount (@lex111)
• docusaurus-types, docusaurus
  • #3531 fix(v2): Fixes serve cli --port option (@UmairKamran)

:nail_care: Polish

• docusaurus-theme-classic
  • #3585 refactor(v2): various dropdown improvements (@lex111)
  • #3588 refactor(v2): make accessible copy code button from keyboard (@lex111)
  • #3578 refactor(v2): apply common behavior to dropdowns (@lex111)
  • #3546 docs: various fixes and improvements (@lex111)
• docusaurus-theme-classic, docusaurus
  • #3587 refactor(v2): various fixes (@lex111)
• docusaurus
  • #3569 refactor(v2): improve broken links error message (@slorber)

:memo: Documentation

• Other
  • #3576 docs(v2): removed obsolete "you" identifier (@christian-bromann)
  • #3589 docs(v2): add taro to users (@honlyHuang)
  • #3565 docs(v2): deployment, add required GitHub token scope infos (@russtaylor)
  • #3574 docs(v2): adding vue-nodegui to users (@shubhamzanwar)
  • #3556 Added Axioms to users (@abhishektiwari)
  • #3558 docs(v2): embedding real source code in MDX as a code block (@slorber)
  • #3555 docs(v2): add "Wisdom" dev docs website to showcase. (@jagracey)
  • #3532 docs(v2): change package name in example script (@MatanBobi)
  • #3538 docs(v1): added drone for 1.0 #3491 (@aakhtar3)
  • #3533 docs(v1): Fix broken link in the documentation (@saintmalik)
  • #3534 docs(v2): Fix url bugs in v2 docs (@saintmalik)
• docusaurus-theme-classic
  • #3546 docs: various fixes and improvements (@lex111)

:house: Internal

• docusaurus-theme-search-algolia
  • #3591 chore(v2): enable new contextual search feature (@slorber)
• Other
  • #3586 chore(v2): fix/upgrade react types (@slorber)
  • #3577 refactor(v2): clarify versions page (@lex111)
  • #3560 feat(v2): prevent using remote image urls in showcase (@slorber)
  • #3554 fix(v2): use absolute path to manifest file (@lex111)
• docusaurus-theme-classic
  • #3394 refactor(v2): add useThemeConfig hook + cleanup useless theme default values (@imskr)

Committers: 17

• Abhishek Tiwari (@abhishektiwari)
• Alexey Pyltsyn (@lex111)
• Bartosz Kaszubowski (@Simek)
• Christian Bromann (@christian-bromann)
• Fanny (@fanny)
• Hamza Hamidi (@hamzahamidi)
• John Gracey (@jagracey)
• Matan Borenkraout (@MatanBobi)
• Russ Taylor (@russtaylor)
• SaintMalik (@saintmalik)
• Shubham Kumar (@imskr)
• Shubham Zanwar (@shubhamzanwar)
• Sébastien Lorber (@slorber)
• Umair Kamran (@UmairKamran)
• Utkarsh Goel (@utkarsh867)
• @aakhtar3
• honlyHuang (@honlyHuang)