@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 v2

Changelog

2.0.0-alpha.65 (2020-10-02)

:rocket: New Feature

• docusaurus
  • #3497 feat(v2): env variable TERSER_PARALLEL to customize TerserPlugin.parallel (@aeneasr)
  • #3446 feat(v2): new docusaurus clear command (@abadon7)
  • #3485 feat(v2): Add @theme-init components to user theme (@edno)
• docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages
  • #3467 feat(v2): add beforeDefaultRemarkPlugins/beforeDefaultRehypePlugins options to all md content plugins (@ayshiff)
• docusaurus-init, docusaurus-theme-bootstrap
  • #3496 feat(v2): migrate bootstrap components to ts (@slorber)
• docusaurus-theme-classic
  • #3474 feat(v2): allow to use array of files in customCss field (@Simek)
• docusaurus-plugin-content-pages, docusaurus-theme-classic
  • #3457 feat(v2): add optional custom wrapper class name for pages based on theme classic Layout (@Simek)

:bug: Bug Fix

• Other
  • #3517 fix(v1): v1 deploy preview should be available (@slorber)
• docusaurus
  • #3498 fix(v2): fixed props being passed to @svgr/webpack loader (@anru)
• docusaurus-theme-search-algolia
  • #3456 fix(v2): use valid value for crossorigin attribute (@lex111)
• docusaurus-utils
  • #3427 fix(v2): normalizeUrl edge cases (@ayshiff)
• docusaurus-theme-classic
  • #3472 fix(v2): Show dropdown instead of a single button when there are two versions (@SamChou19815)
• docusaurus-plugin-content-docs
  • #3441 fix(v2): fixing typo in error message (@ayonious)

:nail_care: Polish

• docusaurus-theme-classic
  • #3499 chore(v2): upgrade Infima to 0.2.0-alpha.13 (@lex111)

:memo: Documentation

• docusaurus
  • #3502 docs(v2): add doc for wrapping theme components with @theme-original and @theme-init (@slorber)
• Other
  • #3473 misc: add License to the documentation (@muskanvk)
  • #3492 docs(v2): Added drone.io publish docs #3491 (@aakhtar3)
  • #3479 docs(v2): remove redundant new line in code block (@lex111)
  • #3448 chore(v2): fix theme classic navbar style docs (@Simek)

:house: Internal

• docusaurus-1.x, docusaurus-migrate
  • #3504 chore(v1): move v1 docs inside website-1.x (@slorber)
• Other
  • #3506 chore(v2): v2 website should make it easy to contribute to upstream docs (@slorber)
  • #3511 misc: update CODEOWNERS (@yangshun)
  • #3477 chore(v2): remove alpha 58 doc (@lex111)
• docusaurus-utils-validation
  • #3453 test(v2): add protocol relative uri validation test (@moonrailgun)

Committers: 18

• Alexey Pyltsyn (@lex111)
• Andrey Rublev (@anru)
• Bartosz Kaszubowski (@Simek)
• Grégory Heitz (@edno)
• Henry Vélez (@abadon7)
• Jeremy Hager (@jeremyhager)
• Joel Marcey (@JoelMarcey)
• Long Ho (@longlho)
• Muskan Kumar (@muskanvk)
• Nahiyan Kamal (@ayonious)
• Rémi Doreau (@ayshiff)
• Sam Zhou (@SamChou19815)
• Sébastien Lorber (@slorber)
• Tim Gates (@timgates42)
• Yangshun Tay (@yangshun)
• @aakhtar3
• hackerman (@aeneasr)
• moonrailgun (@moonrailgun)