Skip to content

Support

DocsForge is free and open source. If you get stuck, need help migrating, or
found a bug — we're here to help.

If migration breaks anything, we fix it for free

Migrating from MkDocs + Material for MkDocs should not cost you a week of
debugging. If your site doesn't build under DocsForge, or renders differently
than it did before:

Send us the details and we will fix DocsForge — or your config — until it
does, at no cost. This offer does not expire.

Open an issue with your
mkdocs.yml and the repo link. Best for open-source sites, since the
discussion helps others hitting the same thing.

Write to qingquanshi65@gmail.com with [MIGRATION] in the subject.
Use this if your docs are private, your config is sensitive, or you'd
simply rather not post it publicly — both routes get the same offer.

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

NeedWhere
Bugs, feature requestsGitHub Issues
Security vulnerabilitiesSecurity policy (private reporting)
Migration help, private questionsqingquanshi65@gmail.com
See it in actionLive demo

What to include in a report

To get the fastest answer, include:

  1. docsforge --version (and Python version, if relevant)
  2. Your operating system
  3. Your docsforge.yml (redacted if private) — or the error message in full
  4. 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