thePR0M3TH3AN/Archivox
1
0
Fork 0
mirror of https://github.com/PR0M3TH3AN/Archivox.git synced 2025-09-09 23:48:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: remove advanced section and add integration guide

Browse Source
This commit is contained in:
thePR0M3TH3AN
2025-07-10 16:00:03 -04:00
parent 245d215230
commit 0f9d2a939c
17 changed files with 74 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/content/01-getting-started/01-install.md
View File

@@ -1,11 +1,11 @@
# Install Archivox
1. Clone or download this repository.
2. Run `npm install` to install dependencies.
1. Clone or download this repository, or run `npx create-archivox my-docs --install` to generate a starter project automatically.
2. Inside the project directory run `npm install` to fetch dependencies.
3. Start the local development server:
```bash
npm run dev
```
The site will be available at `http://localhost:8080`.
Open `http://localhost:8080` to view your site as you edit files.

4
docs/content/01-getting-started/02-build.md
View File

@@ -1,9 +1,9 @@
# Build the Site
When you're ready to generate the static files, run:
Run the build script whenever you want to publish new changes:
```bash
npm run build
```
The output appears in the `_site/` folder.
The compiled HTML, CSS and JavaScript are placed in the `_site/` directory ready to upload to any static host.

2
docs/content/01-getting-started/index.md
View File

@@ -1,3 +1,3 @@
# Getting Started
This section walks you through installing Archivox and creating your first site.
Archivox turns a folder of Markdown files into a searchable documentation site. Follow these pages to install the dependencies, preview your docs locally and produce the final static files.