-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #10 from xian-network/revert-9-main
Revert "Updated documentation"
- Loading branch information
Showing
39 changed files
with
1,298 additions
and
1,989 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,39 +1,21 @@ | ||
# Xian Documentation | ||
|
||
Documentation for the Xian blockchain platform. | ||
|
||
## Quick Start | ||
|
||
### Requirements | ||
- Node.js >= 18 | ||
- npm/yarn | ||
# Docs Readme | ||
|
||
## Quickstart | ||
### Setup | ||
``` | ||
git clone https://github.com/xian-network/docs.git | ||
cd docs | ||
```bash | ||
git clone https://github.com/xian-network/vitepress.git | ||
cd vitepress | ||
npm install | ||
``` | ||
|
||
### Development | ||
``` | ||
```bash | ||
npm run dev | ||
``` | ||
Server starts at `http://localhost:5173` | ||
|
||
### Content Structure | ||
``` | ||
xian-docs/ | ||
├── .vitepress/ # Contains config.mts for navigation/sections | ||
└── src/ # Documentation source files | ||
``` | ||
**Note: New sections must be added to .vitepress/config.mts** | ||
|
||
### Building | ||
Documentation is auto-built and deployed via GitHub Actions on push to main. | ||
|
||
For local builds: | ||
``` | ||
npm run build # Build static site | ||
npm run preview # Preview built site | ||
``` | ||
### Build | ||
- Github actions automatically builds & publishes | ||
- But if you must ... | ||
```bash | ||
npm run build | ||
npm run preview | ||
``` |
Oops, something went wrong.