Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 

README.md

DocsForge Documentation

Built with Material for MkDocs

The official documentation site for DocsForge — a self-contained documentation build system.

🚀 Quick Start

git clone https://github.com/QQSHI13/docsforge-docs.git
cd docsforge-docs
pip install docsforge
docsforge serve

Visit localhost:8000 to preview.

📚 Documentation Structure

Section Description
Getting Started Installation and first steps
Creating Your Site Project structure and configuration
Publishing Deploy to GitHub Pages, Netlify, Vercel
Features Overview of DocsForge capabilities
Blogging Set up a blog with authors, tags, RSS
Setup Guides Customize colors, fonts, navigation, search
Reference Complete Markdown syntax guide
Changelog Version history

🏗️ Building

docsforge build

The static site is generated in the site/ directory.

🌐 Deployment

This site auto-deploys to GitHub Pages via GitHub Actions on every push to main.

Live URL: https://qqshi13.github.io/docsforge-docs/

📄 License

LGPL v3

🤝 Contributing

This documentation is open source. Feel free to open issues or pull requests for improvements.

Star History

Star History Chart