https://github.com/onflow/docs
Flow Developer Portal. Discover the developer ecosystem and master the Flow blockchain
https://github.com/onflow/docs
blockchain cadence docusaurus flow
Last synced: about 2 months ago
JSON representation
Flow Developer Portal. Discover the developer ecosystem and master the Flow blockchain
- Host: GitHub
- URL: https://github.com/onflow/docs
- Owner: onflow
- License: apache-2.0
- Created: 2023-03-08T18:40:19.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-24T13:10:27.000Z (2 months ago)
- Last Synced: 2025-04-24T14:27:39.380Z (2 months ago)
- Topics: blockchain, cadence, docusaurus, flow
- Language: TypeScript
- Homepage: https://developers.flow.com
- Size: 1.03 GB
- Stars: 10
- Watchers: 23
- Forks: 61
- Open Issues: 167
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Website
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
it pulls doc sections from repositories defined in https://github.com/onflow/developer-portal/tree/main/app/data/doc-collections
### Installation
```
$ yarn
```
### Build
```
$ yarn build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
### 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.
### 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.
### Search Indexing
- copy `.env Flow Docusaurus Prod`/`.env Flow Docusaurus Prod` to your local `.env` file from 1Password->`Flow Team` vault