https://github.com/axonweb3/axon-docs
Axon documents site repo.
https://github.com/axonweb3/axon-docs
axon docsite
Last synced: 6 months ago
JSON representation
Axon documents site repo.
- Host: GitHub
- URL: https://github.com/axonweb3/axon-docs
- Owner: axonweb3
- License: mit
- Created: 2022-08-26T06:59:44.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-12-25T01:14:54.000Z (almost 2 years ago)
- Last Synced: 2025-03-23T03:51:17.384Z (7 months ago)
- Topics: axon, docsite
- Language: CSS
- Homepage: https://docs.axonweb3.io
- Size: 42.7 MB
- Stars: 0
- Watchers: 7
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
- Security: docs/security_guideline.mdx
Awesome Lists containing this project
README
# axon-docs
Axon documents repo
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.