This page is currently work in progress.
- Generates HTML documentation from:
- Source file comments written in the standard GTK-Doc format, which are used to generate API documentation for introspected languages.
Hand-written, standalone CommonMark documentation
- Output documentation comes with search and navigation
- Output HTML docs can be themed
- Some support for online editing of docs
Draft plan for migrating away from existing documentation tools (GTK-Doc, library-web) to HotDoc.
Migrating libraries from GTK-Doc to Hotdoc is fairly straightforward. API comments need to be in standard GTK-Doc format and docbook needs to have been completely removed.
TODO: more details and examples needed
Porting to HotDoc would require that we switch away from the existing developer.gnome.org to a new site. This isn't necessarily a bad thing - the current site isn't great. GNOME needs a new, modern developer portal.
For now, the plan is to continue using library-web to generate the release notes and user documentation. However, it might be worth considering alternatives.
Who develops HotDoc?
How can I hack on HotDoc?
See the HotDoc Github repository.
What's HotDoc's development status?
HotDoc is actively being developed, particularly in response to the needs of early adopters.
Have any other projects adopted HotDoc?
Can HotDoc provide translated documentation?
Translations aren't supported at the moment, but they should be possible - the basic plumbing is in place.