https://github.com/dreamfactorysoftware/df-docs
DreamFactory documentation site
https://github.com/dreamfactorysoftware/df-docs
Last synced: 11 months ago
JSON representation
DreamFactory documentation site
- Host: GitHub
- URL: https://github.com/dreamfactorysoftware/df-docs
- Owner: dreamfactorysoftware
- Created: 2023-12-05T22:28:57.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-06-11T20:49:41.000Z (about 1 year ago)
- Last Synced: 2025-06-11T21:58:32.647Z (about 1 year ago)
- Language: TypeScript
- Size: 14.8 MB
- Stars: 3
- Watchers: 4
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Security: docs/Security/_category_.json
Awesome Lists containing this project
README
# Website
This website is built using [Docusaurus 3](https://docusaurus.io/), a modern static website generator.
### Installation
```
$ npm install
```
### Local Development
```
$ npm run 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
```
$ npm run build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
### Deployment
```
$ npm run serve
```
$ GIT_USER= USE_SSH=true 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.