Support
DocsForge is free and open source. If you get stuck, need help migrating, or
found a bug — we're here to help.
Fastest path: the migration one-liner
Coming from MkDocs, ProperDocs, or Zensical? Migrate your existing config
in one command — it converts mkdocs.yml / properdocs.yml / zensical.toml
to docsforge.yml automatically:
curl -fsSL https://qqshi13.github.io/docsforge/migrate.sh | bash
irm https://qqshi13.github.io/docsforge/migrate.ps1 | iex
The script:
- converts navigation, theme, plugins, and extensions,
- warns about anything it can't migrate (third-party plugins,
INHERIT, hooks), - and prints a report telling you exactly what to check.
Anything it couldn't handle? Email us or open an issue — we'll help you port it.
Getting help
| Need | Where |
|---|---|
| Bugs, feature requests | GitHub Issues |
| Security vulnerabilities | Security policy (private reporting) |
| Migration help, private questions | qingquanshi65@gmail.com |
| See it in action | Live demo |
What to include in a report
To get the fastest answer, include:
docsforge --version(and Python version, if relevant)- Your operating system
- Your
docsforge.yml(redacted if private) — or the error message in full - Steps to reproduce
For a plugin, hook, or feature the migration script couldn't convert, tell us:
- the config snippet that failed,
- what you want it to do,
- and we'll port it or point you to a built-in equivalent.
Where to look first
- Troubleshooting — common problems and fixes
- Migration guide — detailed key-by-key mapping
- Changelog — what changed in each release