mirror of
https://github.com/PR0M3TH3AN/Archivox.git
synced 2025-09-08 06:58:43 +00:00
16 lines
544 B
Markdown
16 lines
544 B
Markdown
# Archivox Documentation
|
|
|
|
Welcome to the official documentation for **Archivox**, a lightweight static site generator designed for "Read the Docs" style websites.
|
|
|
|
## Quick Start
|
|
|
|
```bash
|
|
npm install
|
|
npm run dev # start local server at http://localhost:8080
|
|
npm run build # generate the _site/ folder
|
|
```
|
|
|
|
Archivox converts Markdown files inside a `content/` folder into a full documentation site with search, navigation, and responsive design.
|
|
|
|
Check the **Getting Started** section to learn how to install and run Archivox locally.
|