MkLume Support¶
The best place to report MkLume bugs or request features is GitHub Issues:
Open GitHub Issues Download MkLume
What to include¶
Please include as much of this as possible:
| Information | Example |
|---|---|
| MkLume version | 1.0.1 |
| Operating system | Windows 11, macOS, Ubuntu, etc. |
| Project type | New project, existing MkDocs site, GitHub Pages docs, Cloudflare site, etc. |
| What you were doing | Opening a project, building, editing navigation, dragging an image, using Git Sync, etc. |
| What happened | Error message, missing image, frozen preview, failed build, etc. |
| What you expected | What you thought should happen instead. |
Screenshots are very helpful for visual issues.
Before opening an issue¶
Try these quick checks first:
- Open the project root folder, not only the
docs/folder. - Make sure
mkdocs.ymlexists. - Run Project Health.
- Check Troubleshooting.
- Check whether the issue already exists on GitHub.
Email¶
For general ECal Studios contact, email:
For MkLume bugs, GitHub Issues is preferred because it keeps reports easier to track.
Support development¶
MkLume is free and open source. Donations are optional, but appreciated if the app helps you: