@docusaurus/core

What is @docusaurus/core?

@docusaurus/core is a powerful static site generator designed to help you build, deploy, and maintain documentation websites. It is highly customizable and supports modern web development practices, making it a popular choice for creating documentation for open-source projects, products, and more.

What are @docusaurus/core's main functionalities?

Creating a New Docusaurus Site

This command initializes a new Docusaurus site using the 'classic' template. It sets up the basic structure and necessary files for a documentation website.

npx create-docusaurus@latest my-website classic

Adding a New Page

This configuration file (docusaurus.config.js) adds a new page to the Docusaurus site. It includes settings for the navbar, footer, and other site-wide configurations.

module.exports = {
  title: 'My Site',
  tagline: 'Dinosaurs are cool',
  url: 'https://your-docusaurus-test-site.com',
  baseUrl: '/',
  onBrokenLinks: 'throw',
  onBrokenMarkdownLinks: 'warn',
  favicon: 'img/favicon.ico',
  organizationName: 'facebook', // Usually your GitHub org/user name.
  projectName: 'docusaurus', // Usually your repo name.
  themeConfig: {
    navbar: {
      title: 'My Site',
      logo: {
        alt: 'My Site Logo',
        src: 'img/logo.svg',
      },
      items: [
        {
          to: 'docs/',
          activeBasePath: 'docs',
          label: 'Docs',
          position: 'left',
        },
        {to: 'blog', label: 'Blog', position: 'left'},
        {
          href: 'https://github.com/facebook/docusaurus',
          label: 'GitHub',
          position: 'right',
        },
      ],
    },
    footer: {
      style: 'dark',
      links: [
        {
          title: 'Docs',
          items: [
            {
              label: 'Style Guide',
              to: 'docs/',
            },
            {
              label: 'Second Doc',
              to: 'docs/doc2/',
            },
          ],
        },
        {
          title: 'Community',
          items: [
            {
              label: 'Stack Overflow',
              href: 'https://stackoverflow.com/questions/tagged/docusaurus',
            },
            {
              label: 'Discord',
              href: 'https://discordapp.com/invite/docusaurus',
            },
            {
              label: 'Twitter',
              href: 'https://twitter.com/docusaurus',
            },
          ],
        },
        {
          title: 'More',
          items: [
            {
              label: 'Blog',
              to: 'blog',
            },
            {
              label: 'GitHub',
              href: 'https://github.com/facebook/docusaurus',
            },
          ],
        },
      ],
      copyright: `Copyright © ${new Date().getFullYear()} My Project, Inc. Built with Docusaurus.`,
    },
  },
  presets: [
    [
      '@docusaurus/preset-classic',
      {
        docs: {
          sidebarPath: require.resolve('./sidebars.js'),
          // Please change this to your repo.
          editUrl:
            'https://github.com/facebook/docusaurus/edit/master/website/',
        },
        blog: {
          showReadingTime: true,
          // Please change this to your repo.
          editUrl:
            'https://github.com/facebook/docusaurus/edit/master/website/blog/',
        },
        theme: {
          customCss: require.resolve('./src/css/custom.css'),
        },
      },
    ],
  ],
};

Deploying the Site

This command deploys the Docusaurus site to GitHub Pages. It uses the GitHub username and SSH for authentication.

GIT_USER=<Your GitHub username> USE_SSH=true npm run deploy

Other packages similar to @docusaurus/core

vuepress

VuePress is a static site generator powered by Vue.js. It is similar to Docusaurus in that it is used for creating documentation websites, but it leverages the Vue.js ecosystem for theming and customization.

gatsby

Gatsby is a React-based framework for building static sites. It is highly flexible and can be used for a wide range of web applications, including documentation sites. Compared to Docusaurus, Gatsby offers more extensive plugin support and customization options.

mkdocs

MkDocs is a static site generator geared towards project documentation. It is written in Python and uses Markdown for content creation. While it is not as customizable as Docusaurus, it is simple to use and integrates well with Python projects.

README

Docusaurus core

Changelog

2.3.1 (2023-02-03)

:bug: Bug Fix

• docusaurus-theme-common
  • #8628 fix(theme-common): fix issue in tab scroll position restoration on tab click (@slorber)
  • #8619 fix(theme-common): localStorage utils dispatch too many storage events leading to infinite loop (@slorber)
  • #8618 fix(theme-common): prepare usage of useSyncExternalStore compatibility with React 18 (@slorber)
• docusaurus-theme-classic, docusaurus-theme-common
  • #8593 fix(theme-classic): allow rendering single tab item (@Josh-Cena)
• docusaurus-utils
  • #8606 fix(utils): handle CRLF when parsing MDX imports (@scastiel)
• docusaurus-preset-classic
  • #8597 fix(preset-classic): install the right plugin for googleTagManager (@Josh-Cena)

:nail_care: Polish

• docusaurus-theme-translations
  • #8614 chore(theme-translations): complete zh translations (@Josh-Cena)

:robot: Dependencies

• docusaurus-plugin-client-redirects, docusaurus-theme-search-algolia, docusaurus
  • #8610 chore(deps): bump eta from 1.12.3 to 2.0.0 (@dependabot[bot])

Committers: 3

• Joshua Chen (@Josh-Cena)
• Sébastien Castiel (@scastiel)
• Sébastien Lorber (@slorber)