https://github.com/xin-admin/xin-admin-doc
XinAdmin Documentation
https://github.com/xin-admin/xin-admin-doc
Last synced: 12 months ago
JSON representation
XinAdmin Documentation
- Host: GitHub
- URL: https://github.com/xin-admin/xin-admin-doc
- Owner: xin-admin
- License: mit
- Created: 2025-07-14T11:39:02.000Z (12 months ago)
- Default Branch: master
- Last Pushed: 2025-07-15T02:26:04.000Z (12 months ago)
- Last Synced: 2025-07-15T05:29:23.506Z (12 months ago)
- Language: TypeScript
- Size: 2.44 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Website
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
## Installation
```bash
yarn
```
## Local Development
```bash
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
```bash
yarn build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
## Deployment
Using SSH:
```bash
USE_SSH=true yarn deploy
```
Not using SSH:
```bash
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.