@docusaurus/preset-classic is a preset for Docusaurus, a static site generator. It provides a set of plugins and themes that help you quickly set up a documentation website with features like a blog, custom pages, and more.

What are @docusaurus/preset-classic's main functionalities?

Documentation

This feature allows you to set up a documentation site with a sidebar for navigation. The code sample shows how to configure the documentation plugin within the preset.

module.exports = {
  presets: [
    [
      '@docusaurus/preset-classic',
      {
        docs: {
          sidebarPath: require.resolve('./sidebars.js'),
        },
      },
    ],
  ],
};

Blog

This feature enables a blog section on your site. The code sample demonstrates how to configure the blog plugin to show reading time for each post.

module.exports = {
  presets: [
    [
      '@docusaurus/preset-classic',
      {
        blog: {
          showReadingTime: true,
        },
      },
    ],
  ],
};

Custom Pages

This feature allows you to create custom pages for your site. The code sample shows how to configure the pages plugin to use a specific directory for custom pages.

module.exports = {
  presets: [
    [
      '@docusaurus/preset-classic',
      {
        pages: {
          path: 'src/pages',
        },
      },
    ],
  ],
};

Theme

This feature lets you customize the theme of your site. The code sample demonstrates how to include a custom CSS file for additional styling.

module.exports = {
  presets: [
    [
      '@docusaurus/preset-classic',
      {
        theme: {
          customCss: require.resolve('./src/css/custom.css'),
        },
      },
    ],
  ],
};

Other packages similar to @docusaurus/preset-classic

`@docusaurus/preset-classic`

Classic preset for Docusaurus.

Usage

See presets documentation.

3.0.1 (2023-11-30)

:bug: Bug Fix

docusaurus-utils
- #9570 fix: add v2 retrocompatible support for quoted admonitions (@slorber)
- #9535 fix: v3 admonitions should support v2 title syntax for nested admonitions (@slorber)
create-docusaurus, docusaurus-theme-classic, docusaurus-theme-common
- #9567 fix(theme): upgrade prism-react-renderer, fix html script and style tag highlighting (@slorber)
docusaurus-theme-common
- #9531 fix(theme): docs html sidebar items should always be visible (@slorber)
docusaurus-theme-classic
- #9530 fix(theme): fix firefox CSS :has() support bug (@slorber)
create-docusaurus
- #9487 fix(create-docusaurus): fix readme docusaurus 2 ref (@slorber)

:robot: Dependencies

docusaurus-plugin-debug
- #9566 chore(debug-plugin): migrate to a new maintained JSON Viewer (@mcrstudio)
create-docusaurus, docusaurus-theme-classic, docusaurus-theme-common
- #9572 chore: upgrade prism-react-renderer to 2.3.0 to avoid older clsx (@harryzcy)
- #9567 fix(theme): upgrade prism-react-renderer, fix html script and style tag highlighting (@slorber)
create-docusaurus, docusaurus-plugin-pwa, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-theme-search-algolia
- #9464 chore: Upgrade clsx to 2.0.0 (@harryzcy)
docusaurus
- #9547 chore(core): replace wait-on dependency with custom lighter code (@NickGerleman)
docusaurus-plugin-pwa, docusaurus
- #9529 chore: ugrade babel dependencies to v7.23.3 (@reece-white)

Committers: 6

Chongyi Zheng (@harryzcy)
MCR Studio (@mcrstudio)
Nick Gerleman (@NickGerleman)
Shreesh Nautiyal (@Shreesh09)
Sébastien Lorber (@slorber)
@reece-white

FAQs

What is @docusaurus/preset-classic?

Is @docusaurus/preset-classic popular?

Is @docusaurus/preset-classic well maintained?

Package last updated on 30 Nov 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install