https://github.com/remarkablemark/docusaurus-demo
Docusaurus demo
https://github.com/remarkablemark/docusaurus-demo
demo docusaurus website
Last synced: about 9 hours ago
JSON representation
Docusaurus demo
- Host: GitHub
- URL: https://github.com/remarkablemark/docusaurus-demo
- Owner: remarkablemark
- Created: 2022-12-01T04:46:36.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-09-21T07:22:20.000Z (over 1 year ago)
- Last Synced: 2024-10-11T15:13:02.860Z (about 1 year ago)
- Topics: demo, docusaurus, website
- Language: JavaScript
- Homepage: https://remarkablemark.org/docusaurus-demo
- Size: 3.3 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Website
This website is built using [Docusaurus 3](https://docusaurus.io/), a modern static website generator.
## Installation
```sh
npm install
```
## Local Development
```sh
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.
## Build
```sh
npm run build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
## Deployment
Using SSH:
```sh
USE_SSH=true npm run deploy
```
Not using SSH:
```
GIT_USER= npm run 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.
## Scripts
Inside the directory, you can run several commands:
```sh
npm start
```
Starts the development server.
```sh
npm run build
```
Bundles your website into static files for production.
```sh
npm run serve
```
Serves the built website locally.
```sh
npm deploy
```
Publishes the website to GitHub pages.