Add DocForge documentation site

This commit is contained in:
thePR0M3TH3AN
2025-07-10 12:02:39 -04:00
parent c128e20e68
commit 4d924387ce
12 changed files with 94 additions and 0 deletions

6
docs/config.yaml Normal file
View File

@@ -0,0 +1,6 @@
site:
title: "DocForge Docs"
description: "Simple static docs."
navigation:
search: true

View File

@@ -0,0 +1,3 @@
# API Endpoints
If you expose APIs for your project, document them here. DocForge does not impose any format—just write Markdown.

View File

@@ -0,0 +1,3 @@
# Advanced Topics
Use this section for in-depth guides, such as API references or multi-version setups.

View File

@@ -0,0 +1,3 @@
# Customizing Your Site
Site settings live in `config.yaml`. You can change the title, logo, colors, and enable features like analytics or multi-language support.

View File

@@ -0,0 +1,13 @@
# Writing Plugins
Create JavaScript modules in the `plugins/` directory. Export hook functions such as `onParseMarkdown` or `onPageRendered` to modify the build.
Example:
```js
module.exports = {
onPageRendered: async ({ html }) => {
return { html: html + '\n<!-- custom -->' };
}
};
```

View File

@@ -0,0 +1,9 @@
# Deployment
DocForge sites output to the `_site/` folder. Host the contents on any static server. For Netlify, include a `netlify.toml` file:
```toml
[build]
command = "npm run build"
publish = "_site"
```

View File

@@ -0,0 +1,8 @@
# Features Overview
DocForge 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
* Client-side search powered by Lunr.js
* Shortcodes for rich content (images, tabs, notes)

View File

@@ -0,0 +1,11 @@
# Install DocForge
1. Clone or download this repository.
2. Run `npm install` to install dependencies.
3. Start the local development server:
```bash
npm run dev
```
The site will be available at `http://localhost:8080`.

View File

@@ -0,0 +1,9 @@
# Build the Site
When you're ready to generate the static files, run:
```bash
npm run build
```
The output appears in the `_site/` folder.

View File

@@ -0,0 +1,3 @@
# Getting Started
This section walks you through installing DocForge and creating your first site.

15
docs/content/index.md Normal file
View File

@@ -0,0 +1,15 @@
# DocForge Documentation
Welcome to the official documentation for **DocForge**, a lightweight static site generator designed for "Read&nbsp;the&nbsp;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
```
DocForge 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.

11
docs/package.json Normal file
View File

@@ -0,0 +1,11 @@
{
"name": "docs",
"private": true,
"scripts": {
"dev": "eleventy --serve",
"build": "node node_modules/docforge/src/generator/index.js"
},
"dependencies": {
"docforge": "^1.0.0"
}
}