thePR0M3TH3AN/Archivox
1
0
Fork 0
mirror of https://github.com/PR0M3TH3AN/Archivox.git synced 2025-09-15 18:29:13 +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

18
docs/content/05-project-integration/01-setup.md Normal file
View File

@@ -0,0 +1,18 @@
# 1. Download the Starter
Create a `docs/` folder inside your project and fetch the Archivox starter with `wget`:
```bash
mkdir docs && cd docs
wget -O archivox.tar.gz https://codeload.github.com/PR0M3TH3AN/Archivox/tar.gz/refs/heads/main
# extract just the starter directory
mkdir tmp && tar -xzf archivox.tar.gz -C tmp
mv tmp/Archivox-main/starter/* .
rm -rf archivox.tar.gz tmp
```
Install the dependencies locally:
```bash
npm install
```

13
docs/content/05-project-integration/02-config.md Normal file
View File

@@ -0,0 +1,13 @@
# 2. Understand `config.yaml`
The generated `config.yaml` contains basic site information. Adjust the values to match your project:
```yaml
site:
title: "My Project Docs"
description: "Documentation for the project"
navigation:
search: true
```
Change the title and description to what you want displayed in the sidebar and `<head>` tags.

13
docs/content/05-project-integration/03-content.md Normal file
View File

@@ -0,0 +1,13 @@
# 3. Add Documentation Content
Place Markdown files in the `content/` directory. Each folder becomes a sidebar section. Prefix names with numbers to control order:
```
content/
01-getting-started/
01-install.md
02-guides/
feature-a.md
```
The numbers are stripped from page titles but keep everything sorted.

9
docs/content/05-project-integration/04-build.md Normal file
View File

@@ -0,0 +1,9 @@
# 4. Build and Publish
Use the provided `package.json` scripts to generate the site:
```bash
npm run build
```
The static files appear in the `_site/` directory. Configure your CI/CD pipeline to run this command and upload `_site/` as your documentation site.

3
docs/content/05-project-integration/index.md Normal file
View File

@@ -0,0 +1,3 @@
# Using Archivox Inside Another Project
This tutorial shows how to add Archivox to an existing codebase with only a few commands. We'll download the starter files, walk through the configuration and content structure, then configure your build step so the docs publish alongside your project.