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

Merge pull request #8 from PR0M3TH3AN/codex/update-readme-with-quick-start-and-documentation-details

Browse Source 
Improve README onboarding
This commit is contained in:
thePR0M3TH3AN
2025-07-10 10:55:21 -04:00
committed by GitHub
parent 6d14ab247f e7ef43a7ba
commit f35eb47364
1 changed files with 16 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -8,6 +8,18 @@ Built with Node.js (using libraries like Eleventy for templating, `marked` or `r
This final spec incorporates core features, enhancements for usability and performance, and explicit user instructions. It's designed to be implemented as an open-source GitHub repo with a CLI starter kit (e.g., `npx create-docforge my-site`). This final spec incorporates core features, enhancements for usability and performance, and explicit user instructions. It's designed to be implemented as an open-source GitHub repo with a CLI starter kit (e.g., `npx create-docforge my-site`).
## Quick Start
```bash
# install dependencies and start the dev server
npm install
npm run dev
# build the static site
npm run build
```
## Key Features ## Key Features
- **Markdown-Driven Content and Navigation**: - **Markdown-Driven Content and Navigation**:
@@ -156,6 +168,10 @@ To make DocForge truly user-friendly, include these instructions in the starter
- **Multi-Version**: Prefix folders like `content/v1/`, `content/v2/`; config enables switcher. - **Multi-Version**: Prefix folders like `content/v1/`, `content/v2/`; config enables switcher.
- **Multi-Language (Optional)**: Use `content/en/`, `content/fr/` if `features.i18n: true`; add lang switcher. - **Multi-Language (Optional)**: Use `content/en/`, `content/fr/` if `features.i18n: true`; add lang switcher.
### Configuring Versions and Languages
- Add available versions under `navigation.versions` in `config.yaml` and create matching folders (e.g., `content/v1/`, `content/v2/`).
- Enable multiple languages by setting `features.i18n: true` and using subfolders such as `content/en/` or `content/fr/`.
### Formatting Markdown Content ### Formatting Markdown Content
- **Basics**: Use standard Markdown: - **Basics**: Use standard Markdown:
- `# Heading 1` for main titles (auto-generates page TOC). - `# Heading 1` for main titles (auto-generates page TOC).