https://github.com/verida/archived-documentation
https://github.com/verida/archived-documentation
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/verida/archived-documentation
- Owner: verida
- Archived: true
- Created: 2021-12-08T20:51:01.000Z (over 4 years ago)
- Default Branch: develop
- Last Pushed: 2024-08-14T06:28:14.000Z (almost 2 years ago)
- Last Synced: 2025-03-06T11:29:23.467Z (over 1 year ago)
- Language: JavaScript
- Size: 17.9 MB
- Stars: 0
- Watchers: 4
- Forks: 4
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Website
Please see this documentation at [developers.verida.io](https://developers.verida.io).
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.
### Search
Search is implemented using [Offline / Local Search for Docusaurus](https://github.com/cmfcmf/docusaurus-search-local). This is find for our site at the moment but may need to change as it grows. The search is only available from a complete build of the site so to test do this:
```
$ yarn build
$ yarn serve
```
### Deployment
Deployment is autimatically done via [AWS Amplify](https://us-east-2.console.aws.amazon.com/amplify/home?region=us-east-2#/) when changes are merged to the `main` branch.