https://github.com/DocusaurusCommunity/website

Docusaurus.community - Collecting knowledge, tips and tricks for Docusaurus.
https://github.com/DocusaurusCommunity/website

community community-project docusaurus docusaurus-documentation docusaurus-v2

Last synced: about 1 month ago
JSON representation

Docusaurus.community - Collecting knowledge, tips and tricks for Docusaurus.

• Host: GitHub
• URL: https://github.com/DocusaurusCommunity/website
• Owner: DocusaurusCommunity
• License: cc-by-sa-4.0
• Created: 2022-12-03T10:10:09.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-09T17:55:32.000Z (4 months ago)
• Last Synced: 2024-08-09T19:26:00.379Z (4 months ago)
• Topics: community, community-project, docusaurus, docusaurus-documentation, docusaurus-v2
• Language: TypeScript
• Homepage: https://docusaurus.community
• Size: 30.8 MB
• Stars: 25
• Watchers: 3
• Forks: 21
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: contributing/customisations.mdx
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-ccamel - DocusaurusCommunity/website - Docusaurus.community - Collecting knowledge, tips and tricks for Docusaurus. (TypeScript)

README

        
# Docusaurus.community

[![CC BY-SA 4.0][cc-by-sa-shield]][cc-by-sa]

This work is licensed under a [Creative Commons Attribution-ShareAlike 4.0 International License][cc-by-sa].

[![CC BY-SA 4.0][cc-by-sa-image]][cc-by-sa]

[cc-by-sa]: http://creativecommons.org/licenses/by-sa/4.0/

[cc-by-sa-image]: https://licensebuttons.net/l/by-sa/4.0/88x31.png

[cc-by-sa-shield]: https://img.shields.io/badge/License-CC%20BY--SA%204.0-lightgrey.svg

This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.

## Installation

 

```bash

yarn

```

## Local Development

```bash

yarn start

```

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

## Build

```bash

yarn build

```

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

## Deployment

Using SSH:

```bash

USE_SSH=true yarn deploy

```

Not using SSH:

```bash

GIT_USER= yarn deploy

```

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.