https://github.com/webdevstudios/docusaurus-starter
A Docusaurus starter from WebDevStudios.
https://github.com/webdevstudios/docusaurus-starter
documentation docusaurus docusaurus2
Last synced: about 2 months ago
JSON representation
A Docusaurus starter from WebDevStudios.
- Host: GitHub
- URL: https://github.com/webdevstudios/docusaurus-starter
- Owner: WebDevStudios
- License: mit
- Created: 2021-07-08T14:58:45.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2023-03-07T01:44:12.000Z (about 3 years ago)
- Last Synced: 2025-05-10T23:03:10.501Z (12 months ago)
- Topics: documentation, docusaurus, docusaurus2
- Language: JavaScript
- Homepage: https://webdevstudios.github.io/docusaurus-starter/
- Size: 4.26 MB
- Stars: 4
- Watchers: 3
- Forks: 5
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Docusaurus Starter
A Docusaurus starter from WebDevStudios.
[](https://webdevstudios.com/contact/)
## Table of Contents
- [About](#about)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Configuration](#configuration)
- [Development](#development)
- [Linting](#linting)
- [Deployments](#deployments)
- [Content Management](#content-management)
- [Creating Pages](#creating-pages)
- [Algolia Integration](#algolia-integration)
- [Contributing and Support](#contributing-and-support)
## About
[Docusaurus](https://docusaurus.io/) will help you ship a beautiful documentation website in no time. It's an [open-source project](https://github.com/facebook/docusaurus) 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:
```console
git clone git@github.com:WebDevStudios/docusaurus-starter.git
```
Install dependencies:
```console
npm i --legacy-peer-deps
```
Learn more about [installing Docusaurus](https://docusaurus.io/docs/installation).
## Configuration
Please see the `docusaurus.config.js` file in the root of this project. Learn more about [setting up this config](https://docusaurus.io/docs/docusaurus.config.js).
```js
// 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.
```console
npm run dev
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
```console
npm run build
```
### Linting
You can also lint and format the codebase:
```console
npm run lint
```
```console
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.
```console
GIT_USER= USE_SSH=true npm run deploy
```
## Content Management
### Creating Pages
Please see the [official Docusaurus website](https://docusaurus.io/docs/creating-pages) for more info about creating pages, docs, search, and using markdown.
### Algolia Integration
Docusaurus supports Algolia. Please read the [official docs](https://docusaurus.io/docs/search#using-algolia-docsearch) to learn more.
## Contributing and Support
Your contributions and [support tickets](https://github.com/WebDevStudios/docusaurus-starter/issues) are welcome. Please see our [contributing guidelines](https://github.com/WebDevStudios/docusaurus-starter/blob/main/CONTRIBUTING.md) before submitting a pull request.
This is free software and is released under the terms of the MIT license. See [LICENSE.md](https://github.com/WebDevStudios/docusaurus-starter/blob/main/LICENSE.md) for complete license.