mirror of
https://github.com/PR0M3TH3AN/Archivox.git
synced 2025-09-09 15:38:43 +00:00
Rename project to Archivox
This commit is contained in:
@@ -1,5 +1,5 @@
|
||||
site:
|
||||
title: "DocForge Docs"
|
||||
title: "Archivox Docs"
|
||||
description: "Simple static docs."
|
||||
|
||||
navigation:
|
||||
@@ -8,6 +8,6 @@ navigation:
|
||||
footer:
|
||||
links:
|
||||
- text: "GitHub"
|
||||
url: "https://github.com/yourusername/DocForge"
|
||||
url: "https://github.com/yourusername/Archivox"
|
||||
- text: "License"
|
||||
url: "/license.html"
|
||||
|
@@ -1,3 +1,3 @@
|
||||
# API Endpoints
|
||||
|
||||
If you expose APIs for your project, document them here. DocForge does not impose any format—just write Markdown.
|
||||
If you expose APIs for your project, document them here. Archivox does not impose any format—just write Markdown.
|
||||
|
@@ -1,6 +1,6 @@
|
||||
# Deployment
|
||||
|
||||
DocForge sites output to the `_site/` folder. Host the contents on any static server. For Netlify, include a `netlify.toml` file:
|
||||
Archivox sites output to the `_site/` folder. Host the contents on any static server. For Netlify, include a `netlify.toml` file:
|
||||
|
||||
```toml
|
||||
[build]
|
||||
|
@@ -1,6 +1,6 @@
|
||||
# Features Overview
|
||||
|
||||
DocForge automatically turns your Markdown files into a full documentation site with a responsive layout and search.
|
||||
Archivox automatically turns your Markdown files into a full documentation site with a responsive layout and search.
|
||||
|
||||
* Sidebar navigation generated from folders
|
||||
* Collapsible mobile menu and dark-mode switch
|
||||
|
@@ -1,4 +1,4 @@
|
||||
# Install DocForge
|
||||
# Install Archivox
|
||||
|
||||
1. Clone or download this repository.
|
||||
2. Run `npm install` to install dependencies.
|
||||
|
@@ -1,3 +1,3 @@
|
||||
# Getting Started
|
||||
|
||||
This section walks you through installing DocForge and creating your first site.
|
||||
This section walks you through installing Archivox and creating your first site.
|
||||
|
@@ -1,6 +1,6 @@
|
||||
# DocForge Documentation
|
||||
# Archivox Documentation
|
||||
|
||||
Welcome to the official documentation for **DocForge**, a lightweight static site generator designed for "Read the Docs" style websites.
|
||||
Welcome to the official documentation for **Archivox**, a lightweight static site generator designed for "Read the Docs" style websites.
|
||||
|
||||
## Quick Start
|
||||
|
||||
@@ -10,6 +10,6 @@ npm run dev # start local server at http://localhost:8080
|
||||
npm run build # generate the _site/ folder
|
||||
```
|
||||
|
||||
DocForge converts Markdown files inside a `content/` folder into a full documentation site with search, navigation, and responsive design.
|
||||
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 DocForge locally.
|
||||
Check the **Getting Started** section to learn how to install and run Archivox locally.
|
||||
|
@@ -3,9 +3,9 @@
|
||||
"private": true,
|
||||
"scripts": {
|
||||
"dev": "eleventy --serve",
|
||||
"build": "node node_modules/docforge/src/generator/index.js"
|
||||
"build": "node node_modules/archivox/src/generator/index.js"
|
||||
},
|
||||
"dependencies": {
|
||||
"docforge": "^1.0.0"
|
||||
"archivox": "^1.0.0"
|
||||
}
|
||||
}
|
Reference in New Issue
Block a user