mirror/Libation
1
0
Fork 0
mirror of https://github.com/rmcrackan/Libation.git synced 2025-12-23 22:17:52 -05:00
Code Issues Packages Projects Releases Wiki Activity

make documentation development section in readme concise

Browse Source
This commit is contained in:
radiorambo
2025-12-15 17:50:39 +05:30
parent b567c38a98
commit c1bd1d983b
1 changed files with 10 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
README.md
View File

@@ -3,48 +3,29 @@
## [Download Libation](https://github.com/rmcrackan/Libation/releases/latest) ## [Download Libation](https://github.com/rmcrackan/Libation/releases/latest)
### If you found this useful, tell a friend. If you found this REALLY useful, you can click here to [PayPal.me](https://paypal.me/mcrackan?locale.x=en_us) ### If you found this useful, tell a friend. If you found this REALLY useful, you can click here to [PayPal.me](https://paypal.me/mcrackan?locale.x=en_us)
...or just tell more friends. As long as I'm maintaining this software, it will remain **free** and **open source**. ...or just tell more friends. As long as I'm maintaining this software, it will remain **free** and **open source**.
## Development ## Development
### Documentation ### Documentation
The documentation is built with [VitePress](https://vitepress.dev/). For more information, see the [VitePress documentation](https://vuejs.github.io/vitepress/v1/guide/getting-started). The documentation is built with [VitePress](https://vitepress.dev/) and located in the `docs` directory. For more information like [markdown syntax](https://vitepress.dev/guide/markdown#advanced-configuration) and [routing](https://vitepress.dev/guide/routing) or other features, refer [VitePress documentation](https://vitepress.dev/guide).
### Prerequisites **Prerequisites**: Node.js 18+
- [Node.js](https://nodejs.org/) version 18 or higher **Commands**:
### Setup
Install dependencies:
```bash ```bash
# Install dependencies
npm install npm install
```
### Development # Start local dev server (http://localhost:5173)
Start the local dev server with hot reload:
```bash
npm run docs:dev npm run docs:dev
```
The site will be available at `http://localhost:5173`. # Build for production (output: docs/.vitepress/dist)
### Build
Build the static site for production:
```bash
npm run docs:build npm run docs:build
```
Preview the production build locally: # Preview production build
```bash
npm run docs:preview npm run docs:preview
``` ```
### Deployment
The built site is output to `Documentation/.vitepress/dist`. Deploy this directory to any static hosting service (GitHub Pages, Cloudflare Pages, Vercel, Netlify, etc.).