@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

2.0.0-beta.9 (2021-11-02)

:rocket: New Feature

• docusaurus-theme-classic, docusaurus-theme-common
  • #5770 feat(theme-classic): allow specifying width/height in logo (@cerkiewny)
• docusaurus-types, docusaurus
  • #5841 feat: allow user to specify deploymentBranch property in docusaurus.config.js (@wpyoga)
• docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-search-algolia
  • #5795 feat(search-algolia): algolia externalUrl regex to navigate with window.href (@semoal)
• docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-ideal-image, docusaurus-plugin-pwa, docusaurus-types, docusaurus
  • #5814 feat: Support Node 17 (@slorber)
  • #5420 feat(core): upgrade to webpack-dev-server@4 (@AviVahl)
• docusaurus-theme-classic
  • #5791 feat(theme-classic): add Serbian Cyrillic translation (@utajum)

:boom: Breaking Change

• create-docusaurus, docusaurus-mdx-loader, docusaurus-migrate, 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-ideal-image, docusaurus-plugin-sitemap, docusaurus-preset-classic, docusaurus-remark-plugin-npm2yarn, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-theme-search-algolia, docusaurus-utils-common, docusaurus-utils-validation, docusaurus-utils, docusaurus, lqip-loader
  • #5812 chore: require Node 14 (@slorber)

:bug: Bug Fix

• docusaurus-plugin-content-blog
  • #5835 fix(content-blog): Fix blog feeds not generated (@slorber)
• docusaurus
  • #5828 fix: include all branch tips for shallow clone in deploy command (@sivapalan)
  • #5824 fix: baseUrl passed to sortConfig (@semoal)
  • #5813 fix: handle SIGTERM in build command (@slorber)
• docusaurus-module-type-aliases, docusaurus
  • #5819 fix: use @docusaurus/react-loadable as package alias + include types (@slorber)

:nail_care: Polish

• docusaurus-preset-classic
  • #5831 feat(preset-classic): guard against unknown keys in options (@Josh-Cena)
• docusaurus
  • #5815 refactor: some improvements for webpack-dev-server (@lex111)
• docusaurus-theme-classic, docusaurus-theme-common, docusaurus-utils, docusaurus
  • #5788 refactor: fix a few type inconsistencies (@Josh-Cena)
• docusaurus-theme-classic
  • #5781 refactor: Vietnamese translations (@datlechin)

:memo: Documentation

• Other
  • #5853 docs: Fix a typo in CONTRIBUTING.md (@fishmandev)
  • #5852 docs: Fix a typo in versioning.md (@fishmandev)
  • #5847 docs: add InfraQL product docs website to showcase (@jeffreyaven)
  • #5843 docs: fix i18n routes to feature requests (@Josh-Cena)
  • #5766 docs: elaborate on the usage of MDX plugins (@cerkiewny)
  • #5826 docs: fix lint issue (@slorber)
  • #5801 docs: Update Drone Deployment docs (@gabrielfalcao)
  • #5821 docs: include navbar item type in the API table (@Josh-Cena)
  • #5820 docs: add @Josh-Cena to the team (@Josh-Cena)
  • #5818 doc: fix typo in "create a doc" (@dominikmeyersap)
  • #5797 docs: use "npx create-docusaurus" for init (@slorber)
  • #5771 docs: Minor update to grammar in plugins overview page (@robbieaverill)
  • #5774 docs: update ssrTemplate (@juzhiyuan)
  • #5784 docs: fix link for apply to DocSearch program (@lex111)
• create-docusaurus
  • #5792 docs: fix typo (@wingclover)

:house: Internal

• Other
  • #5842 misc: add "name" field for root package.json (@wpyoga)
  • #5836 chore: switch to GitHub issue forms (@lex111)
  • #5834 chore(issue templ): add "self service" section in templates (@Josh-Cena)
  • #5833 chore(workflow): remove v2 prefix from titles (@Josh-Cena)
  • #5697 chore(workflow): add cache to workflows using actions/setup-node (@oscard0m)
  • #5825 chore: fix Crowdin again (@slorber)
  • #5823 chore: replace doc sample .pdf file by .xlsx to solve Crowdin issue (@slorber)
  • #5763 chore: update examples for beta.8 (@slorber)
• create-docusaurus, docusaurus-mdx-loader, docusaurus-migrate, 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-ideal-image, docusaurus-plugin-sitemap, docusaurus-preset-classic, docusaurus-remark-plugin-npm2yarn, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-theme-search-algolia, docusaurus-utils-common, docusaurus-utils-validation, docusaurus-utils, docusaurus, lqip-loader
  • #5812 chore: require Node 14 (@slorber)
• docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-theme-classic, docusaurus
  • #5807 refactor: remove a few Lodash usages & ESLint enforcement (@Josh-Cena)
• docusaurus-module-type-aliases, docusaurus-plugin-client-redirects, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-utils, docusaurus
  • #5808 refactor: clear a few ESLint warnings (@Josh-Cena)
• docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, lqip-loader
  • #5779 refactor: migrate lqip-loader to TS, fix typing for Webpack Loaders (@Josh-Cena)

Committers: 18

• Alexey Pyltsyn (@lex111)
• Avi Vahl (@AviVahl)
• Devtato (@cerkiewny)
• Dmitriy Fishman (@fishmandev)
• Dominik Meyer (@dominikmeyersap)
• Gabriel Falcão (@gabrielfalcao)
• Jeffrey Aven (@jeffreyaven)
• Joshua Chen (@Josh-Cena)
• Ngô Quốc Đạt (@datlechin)
• Oscar Dominguez (@oscard0m)
• Robbie Averill (@robbieaverill)
• Sergio Moreno (@semoal)
• Sébastien Lorber (@slorber)
• Varun Sivapalan (@sivapalan)
• Vladimir Tasic (@utajum)
• William Poetra Yoga (@wpyoga)
• Ying Wang (@wingclover)
• 琚致远 (@juzhiyuan)