https://github.com/agarthetiger/docusaurus
Repo to play with Docusaurus.io, GitHub Pages and Actions
https://github.com/agarthetiger/docusaurus
docusaurus docusaurus-v2
Last synced: 12 months ago
JSON representation
Repo to play with Docusaurus.io, GitHub Pages and Actions
- Host: GitHub
- URL: https://github.com/agarthetiger/docusaurus
- Owner: agarthetiger
- Created: 2022-12-15T17:04:15.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-28T11:26:31.000Z (about 1 year ago)
- Last Synced: 2025-04-28T12:35:52.127Z (about 1 year ago)
- Topics: docusaurus, docusaurus-v2
- Language: JavaScript
- Homepage: https://agarthetiger.github.io/docusaurus/
- Size: 7.88 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Docusaurus website
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator. See it live at https://agarthetiger.github.io/docusaurus
### Installation
```
$ npm install
```
### Local Development
```
$ npm 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.
Note that the search plugin being used, https://github.com/praveenn77/docusaurus-lunr-search , requires a production 'build' to generate the index. See build below.
```
npm build
npm run serve
```
Commit straight to `main`, there is no need on a personal website to use any branching other than using `gh-pages` to serve the static website.
### Build
```
$ npm build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
### Deployment
While it is possible to deploy this to the gh-pages branch from local, best not to. GitHub Actions is configured to build and deploy from the main branch.
### Configuration
