isabella232 / docusaurus-starter

A Docusaurus starter from WebDevStudios.

Docusaurus Starter

A Docusaurus starter from WebDevStudios.

https://webdevstudios.github.io/docusaurus-starter/

Table of Contents

• About
• Setup
  • Prerequisites
  • Install
• Configuration
• Development
  • Linting
  • Deployments
• Content Management
  • Creating Pages
  • Algolia Integration
• Contributing and Support

About

Docusaurus will help you ship a beautiful documentation website in no time. It's an open-source project maintained by the engineers at Facebook.

At WebDevStudios we love to write documentation! We also love standards, linting, and have a particular way of writing React. This starter gives our team members a standard way of spinning up documentation-based websites powered by Docusaurus v2.

Setup

Prerequisites

• Node 14+
• NPM 7+

Install

Close the repo:

git clone [email protected]:WebDevStudios/docusaurus-starter.git

Install dependencies:

npm i --legacy-peer-deps

Learn more about installing Docusaurus.

Configuration

Please see the docusaurus.config.js file in the root of this project. Learn more about setting up this config.

// the basic shape of docusaurus.config.js
module.exports = {
  title: 'Docusaurus',
  tagline: 'A Docusaurus starter from WebDevStudios',
  url: 'https://webdevstudios.com',
  baseUrl: '/docusaurus-starter/',
  onBrokenLinks: 'throw',
  onBrokenMarkdownLinks: 'warn',
  favicon: 'img/favicon.ico',
  organizationName: 'webdevstudios',
  projectName: 'docusaurus-starter',
  themeConfig: {
    navbar: {},
    footer: {},
    prism: {}
  },
  presets: [['@docusaurus/preset-classic']]
}

Development

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

npm run dev

This command generates static content into the build directory and can be served using any static contents hosting service.

npm run build

Linting

You can also lint and format the codebase:

npm run lint

npm run format

Deployments

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.

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

Content Management

Creating Pages

Please see the official Docusaurus website for more info about creating pages, docs, search, and using markdown.

Algolia Integration

Docusaurus supports Algolia. Please read the official docs to learn more.

Contributing and Support

Your contributions and support tickets are welcome. Please see our contributing guidelines before submitting a pull request.

This is free software and is released under the terms of the MIT license. See LICENSE.md for complete license.