Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

@docusaurus/core

Package Overview
Dependencies
Maintainers
5
Versions
1808
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@docusaurus/core

Easy to Maintain Open Source Documentation Websites

  • 2.0.0-alpha.58
  • Source
  • npm
  • Socket score
Version published
Weekly downloads
369K
increased by1.65%
Maintainers
5
Weekly downloads
 
Created

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.

Keywords

FAQs

Package last updated on 18 Jun 2020

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

JSR Working Group Kicks Off with Ambitious Roadmap and Plans for Open Governance

Security News

JSR Working Group Kicks Off with Ambitious Roadmap and Plans for Open Governance

At its inaugural meeting, the JSR Working Group outlined plans for an open governance model and a roadmap to enhance JavaScript package management.

By Sarah Gooding  -  Nov 05, 2024
SocketSocket SOC 2 Logo

Product

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

About

Packages

npm

Go

Maven

PyPI

Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc