https://github.com/gldraphael/docusaurus-fm-exp
https://github.com/gldraphael/docusaurus-fm-exp
Last synced: 17 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/gldraphael/docusaurus-fm-exp
- Owner: gldraphael
- Created: 2023-02-07T06:47:52.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-07T07:14:42.000Z (over 3 years ago)
- Last Synced: 2025-10-27T10:42:50.468Z (9 months ago)
- Language: JavaScript
- Homepage: https://github.com/FrontMatter/feedback/discussions/2
- Size: 457 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
1. Created the repository with:
```
npx create-docusaurus@latest docusaurus-fm-exp classic --typescript
```
1. Removed the blog and made the docs accessible at `/` instead of `/docs/`.
1. Setup `frontmatter.json` using the Front Matter VS extension's "Initialize Project" wizard.
---
# Website
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
### Installation
```
$ yarn
```
### Local Development
```
$ 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
```
$ yarn build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
### Deployment
Using SSH:
```
$ USE_SSH=true yarn deploy
```
Not using SSH:
```
$ 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.