You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 7-8.RSVP
Socket
Socket
Sign inDemoInstall

@docusaurus/preset-classic

Package Overview
Dependencies
Maintainers
4
Versions
1714
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@docusaurus/preset-classic

Classic preset for Docusaurus.


Version published
Weekly downloads
270K
decreased by-1.76%
Maintainers
4
Created
Weekly downloads
 

Package description

What is @docusaurus/preset-classic?

@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

Changelog

Source

3.1.1 (2024-01-26)

:bug: Bug Fix
  • docusaurus-types, docusaurus
    • #9791 fix(core): broken links optimization behaves differently than non-optimized logic (@slorber)
  • docusaurus
    • #9788 fix(core): links with target "_blank" should no be checked by the broken link checker (@slorber)
    • #9407 fix(core): conditionally include hostname parameter when using… (@jack-robson)
  • docusaurus-utils
    • #9776 fix(mdx-loader): allow spaces before mdx-code-block info string (@eitsupi)
  • create-docusaurus
    • #9783 fix(create-docusaurus): fix typo in init template sample docs (@dawei-wang)
  • docusaurus-theme-common
    • #9727 fix(theme-common): fix missing code block MagicComments style in Visual Basic (.NET) 16 (@tats-u)
  • docusaurus-theme-classic, docusaurus-theme-mermaid
  • docusaurus-module-type-aliases, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-utils, docusaurus
:running_woman: Performance
  • docusaurus
:nail_care: Polish
  • docusaurus-theme-classic
Committers: 6

Readme

Source

@docusaurus/preset-classic

Classic preset for Docusaurus.

Usage

See presets documentation.

FAQs

Package last updated on 26 Jan 2024

Did you know?

Socket

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

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc