docsforge 10.1.0__tar.gz → 10.2.0__tar.gz

docsforge-10.2.0/.gitignore

@@ -0,0 +1,12 @@
+.venv/
+__pycache__/
+*.egg-info/
+dist/
+build/
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+*.pyc
+.DS_Store
+# Downloaded during build
+docsforge/themes/material/templates/.icons/

docsforge-10.2.0/PKG-INFO

@@ -0,0 +1,222 @@
+Metadata-Version: 2.4
+Name: docsforge
+Version: 10.2.0
+Summary: Self-contained unified documentation engine with Material theme.
+Project-URL: Documentation, https://docsforge.readthedocs.io/
+Project-URL: Source, https://github.com/docsforge/docsforge
+Project-URL: Issues, https://github.com/docsforge/docsforge/issues
+Author: DocsForge Contributors
+License-Expression: LGPL-3.0-or-later
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Documentation
+Classifier: Topic :: Text Processing
+Requires-Python: >=3.10
+Requires-Dist: babel>=2.9.0
+Requires-Dist: backrefs>=5.0
+Requires-Dist: click>=7.0
+Requires-Dist: colorama>=0.4
+Requires-Dist: ghp-import>=1.0
+Requires-Dist: jinja2>=2.11.1
+Requires-Dist: markdown>=3.3.6
+Requires-Dist: markupsafe>=2.0.1
+Requires-Dist: mergedeep>=1.3.4
+Requires-Dist: packaging>=20.5
+Requires-Dist: paginate>=0.5
+Requires-Dist: pathspec>=0.11.1
+Requires-Dist: platformdirs>=2.2.0
+Requires-Dist: pygments>=2.16
+Requires-Dist: pymdown-extensions>=10.0
+Requires-Dist: pyyaml-env-tag>=0.1
+Requires-Dist: pyyaml>=5.1
+Requires-Dist: requests>=2.27
+Requires-Dist: watchdog>=2.0
+Provides-Extra: imaging
+Requires-Dist: cairosvg>=2.6; extra == 'imaging'
+Requires-Dist: pillow>=10.2; extra == 'imaging'
+Description-Content-Type: text/markdown
+
+# DocsForge
+
+> **One package. One command. Beautiful docs.**
+
+[![PyPI](https://img.shields.io/pypi/v/docsforge)](https://pypi.org/project/docsforge/)
+[![Docs](https://img.shields.io/badge/docs-online-blue)](https://qqshi13.github.io/docsforge-docs/)
+[![License](https://img.shields.io/badge/license-LGPL%20v3-blue.svg)](LICENSE)
+
+DocsForge unifies the [ProperDocs](https://github.com/properdocs/properdocs) documentation engine and the [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) theme into a single, installable package. You write content. DocsForge handles the engine, the theme, and the plugins.
+
+📖 **[Documentation](https://qqshi13.github.io/docsforge-docs/)** | 📦 **[PyPI](https://pypi.org/project/docsforge/)** | 🐙 **[GitHub](https://github.com/QQSHI13/docsforge)**
+
+---
+
+## Vision
+
+MkDocs is effectively unmaintained. Material for MkDocs is in maintenance mode. [ProperDocs](https://github.com/properdocs/properdocs) is the actively maintained fork of MkDocs that keeps the ecosystem alive.
+
+DocsForge makes the successor ecosystem effortless:
+
+- **One `pip install`** gets you the engine + theme + recommended plugins.
+- **One config file** (`docsforge.yml`) with no boilerplate `plugins:` list.
+- **Backward compatible** — existing `mkdocs.yml` files work unchanged.
+- **Plugin system stays alive** — we just auto-register Material plugins so you never write a `plugins:` section.
+
+---
+
+## Installation
+
+```bash
+pip install docsforge
+```
+
+That's it. ProperDocs, Material for MkDocs, and common plugins are installed together.
+
+---
+
+## Quick Start
+
+### 1. Create a new site
+
+```bash
+docsforge new my-docs
+cd my-docs
+```
+
+This scaffolds:
+
+```
+my-docs/
+├── docsforge.yml          # Config with Material theme pre-selected
+└── docs/
+    └── index.md           # Starter page
+```
+
+### 2. Preview locally
+
+```bash
+docsforge serve
+```
+
+Material plugins (search, tags, etc.) are **auto-registered** — no `plugins:` list needed.
+
+### 3. Build for production
+
+```bash
+docsforge build
+```
+
+### 4. Deploy to GitHub Pages
+
+```bash
+docsforge gh-deploy
+```
+
+---
+
+## Config File
+
+DocsForge looks for config in this priority:
+
+1. `docsforge.yml` / `docsforge.yaml` ← **preferred**
+2. `properdocs.yml` / `properdocs.yaml`
+3. `mkdocs.yml` / `mkdocs.yaml` ← legacy fallback
+
+### Minimal `docsforge.yml`
+
+```yaml
+site_name: My Documentation
+site_url: https://example.com/
+repo_url: https://github.com/username/repo
+
+# Theme defaults to "material" — you can omit this entirely.
+theme:
+  name: material
+
+# No plugins: section needed — search, tags, blog, privacy, social
+# are auto-registered based on what you have installed.
+```
+
+### Advanced — override auto-plugins
+
+If you define `plugins:` yourself, DocsForge **merges** rather than overwrites:
+
+```yaml
+site_name: My Docs
+
+plugins:
+  search:
+    lang: en
+  tags:
+    tags_file: tags.md
+  # blog, privacy, social are still auto-registered if available
+```
+
+---
+
+## CLI Reference
+
+| Command | Description |
+|---------|-------------|
+| `docsforge new <name>` | Scaffold a new project |
+| `docsforge serve` | Live-reload dev server |
+| `docsforge build` | Static site build |
+| `docsforge gh-deploy` | Deploy to GitHub Pages |
+
+All commands accept `-f / --config-file` to override config discovery.
+
+---
+
+## Architecture
+
+```
+docsforge/                    # Unified package
+├── __init__.py
+├── cli.py                    # `docsforge` command (wraps properdocs)
+├── config.py                 # Unified config loader
+├── plugins/
+│   └── auto_register.py      # Pre-loads Material plugins
+├── engine/                   # ProperDocs core (git subtree)
+│   └── (properdocs source)
+└── themes/                   # Material for MkDocs (git subtree)
+    └── (mkdocs-material source)
+```
+
+**Key decisions:**
+
+1. **Keep the plugin system alive.** Material's plugins (blog, tags, privacy, social, search) are powerful. We auto-register them instead of rewriting them.
+2. **ProperDocs dual entrypoints.** ProperDocs already supports both `mkdocs.*` and `properdocs.*` entrypoints, so Material works without code changes.
+3. **Unified CLI, not a fork.** We wrap ProperDocs commands; we don't fork the engine.
+
+See [ARCHITECTURE.md](ARCHITECTURE.md) for the full design record.
+
+---
+
+## License
+
+GPL-3.0-or-later — same as ProperDocs.
+
+---
+
+*DocsForge is a repackaging project, not a fork. It keeps the MkDocs/ProperDocs ecosystem moving forward while the upstreams navigate their maintenance transitions.*
+
+---
+
+## Star History
+
+<a href="https://www.star-history.com/?repos=QQSHI13%2Fdocsforge&type=date&legend=top-left">
+ <picture>
+ <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/chart?repos=QQSHI13/docsforge&type=date&theme=dark&legend=top-left" />
+ <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/chart?repos=QQSHI13/docsforge&type=date&legend=top-left" />
+ <img alt="Star History Chart" src="https://api.star-history.com/chart?repos=QQSHI13/docsforge&type=date&legend=top-left" />
+ </picture>
+</a>

docsforge-10.2.0/README.md

@@ -0,0 +1,174 @@
+# DocsForge
+
+> **One package. One command. Beautiful docs.**
+
+[![PyPI](https://img.shields.io/pypi/v/docsforge)](https://pypi.org/project/docsforge/)
+[![Docs](https://img.shields.io/badge/docs-online-blue)](https://qqshi13.github.io/docsforge-docs/)
+[![License](https://img.shields.io/badge/license-LGPL%20v3-blue.svg)](LICENSE)
+
+DocsForge unifies the [ProperDocs](https://github.com/properdocs/properdocs) documentation engine and the [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) theme into a single, installable package. You write content. DocsForge handles the engine, the theme, and the plugins.
+
+📖 **[Documentation](https://qqshi13.github.io/docsforge-docs/)** | 📦 **[PyPI](https://pypi.org/project/docsforge/)** | 🐙 **[GitHub](https://github.com/QQSHI13/docsforge)**
+
+---
+
+## Vision
+
+MkDocs is effectively unmaintained. Material for MkDocs is in maintenance mode. [ProperDocs](https://github.com/properdocs/properdocs) is the actively maintained fork of MkDocs that keeps the ecosystem alive.
+
+DocsForge makes the successor ecosystem effortless:
+
+- **One `pip install`** gets you the engine + theme + recommended plugins.
+- **One config file** (`docsforge.yml`) with no boilerplate `plugins:` list.
+- **Backward compatible** — existing `mkdocs.yml` files work unchanged.
+- **Plugin system stays alive** — we just auto-register Material plugins so you never write a `plugins:` section.
+
+---
+
+## Installation
+
+```bash
+pip install docsforge
+```
+
+That's it. ProperDocs, Material for MkDocs, and common plugins are installed together.
+
+---
+
+## Quick Start
+
+### 1. Create a new site
+
+```bash
+docsforge new my-docs
+cd my-docs
+```
+
+This scaffolds:
+
+```
+my-docs/
+├── docsforge.yml          # Config with Material theme pre-selected
+└── docs/
+    └── index.md           # Starter page
+```
+
+### 2. Preview locally
+
+```bash
+docsforge serve
+```
+
+Material plugins (search, tags, etc.) are **auto-registered** — no `plugins:` list needed.
+
+### 3. Build for production
+
+```bash
+docsforge build
+```
+
+### 4. Deploy to GitHub Pages
+
+```bash
+docsforge gh-deploy
+```
+
+---
+
+## Config File
+
+DocsForge looks for config in this priority:
+
+1. `docsforge.yml` / `docsforge.yaml` ← **preferred**
+2. `properdocs.yml` / `properdocs.yaml`
+3. `mkdocs.yml` / `mkdocs.yaml` ← legacy fallback
+
+### Minimal `docsforge.yml`
+
+```yaml
+site_name: My Documentation
+site_url: https://example.com/
+repo_url: https://github.com/username/repo
+
+# Theme defaults to "material" — you can omit this entirely.
+theme:
+  name: material
+
+# No plugins: section needed — search, tags, blog, privacy, social
+# are auto-registered based on what you have installed.
+```
+
+### Advanced — override auto-plugins
+
+If you define `plugins:` yourself, DocsForge **merges** rather than overwrites:
+
+```yaml
+site_name: My Docs
+
+plugins:
+  search:
+    lang: en
+  tags:
+    tags_file: tags.md
+  # blog, privacy, social are still auto-registered if available
+```
+
+---
+
+## CLI Reference
+
+| Command | Description |
+|---------|-------------|
+| `docsforge new <name>` | Scaffold a new project |
+| `docsforge serve` | Live-reload dev server |
+| `docsforge build` | Static site build |
+| `docsforge gh-deploy` | Deploy to GitHub Pages |
+
+All commands accept `-f / --config-file` to override config discovery.
+
+---
+
+## Architecture
+
+```
+docsforge/                    # Unified package
+├── __init__.py
+├── cli.py                    # `docsforge` command (wraps properdocs)
+├── config.py                 # Unified config loader
+├── plugins/
+│   └── auto_register.py      # Pre-loads Material plugins
+├── engine/                   # ProperDocs core (git subtree)
+│   └── (properdocs source)
+└── themes/                   # Material for MkDocs (git subtree)
+    └── (mkdocs-material source)
+```
+
+**Key decisions:**
+
+1. **Keep the plugin system alive.** Material's plugins (blog, tags, privacy, social, search) are powerful. We auto-register them instead of rewriting them.
+2. **ProperDocs dual entrypoints.** ProperDocs already supports both `mkdocs.*` and `properdocs.*` entrypoints, so Material works without code changes.
+3. **Unified CLI, not a fork.** We wrap ProperDocs commands; we don't fork the engine.
+
+See [ARCHITECTURE.md](ARCHITECTURE.md) for the full design record.
+
+---
+
+## License
+
+GPL-3.0-or-later — same as ProperDocs.
+
+---
+
+*DocsForge is a repackaging project, not a fork. It keeps the MkDocs/ProperDocs ecosystem moving forward while the upstreams navigate their maintenance transitions.*
+
+---
+
+## Star History
+
+<a href="https://www.star-history.com/?repos=QQSHI13%2Fdocsforge&type=date&legend=top-left">
+ <picture>
+ <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/chart?repos=QQSHI13/docsforge&type=date&theme=dark&legend=top-left" />
+ <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/chart?repos=QQSHI13/docsforge&type=date&legend=top-left" />
+ <img alt="Star History Chart" src="https://api.star-history.com/chart?repos=QQSHI13/docsforge&type=date&legend=top-left" />
+ </picture>
+</a>

docsforge-10.2.0/docsforge/__init__.py

@@ -0,0 +1,11 @@
+"""DocsForge - Unified documentation engine with Material theme.
+
+DocsForge combines the ProperDocs build engine with the Material for MkDocs
+theme and plugins into a single, cohesive package.
+"""
+
+__version__ = "10.2.0"
+__prog_name__ = "docsforge"
+
+# Install vendor compatibility shims
+import docsforge._vendor_shims