Documentation should just work.
Documentation tools have a habit of becoming projects of their own.
You start with a few Markdown files.
Then come the configuration files. The overrides. The ejecting. The swizzling.
“Surely there’s a better way to do this.”
There should be.
Four ideas behind every decision.
- 01
Configure, don’t modify.
Your documentation should adapt to your project, not the other way around.
ctrl alt doc gives you sensible defaults and one public configuration API. The framework does the heavy lifting without asking you to change its internals.
- 02
Content comes first.
Your documentation is the product.
The framework handles navigation, search, presentation and the machinery around them, so you can concentrate on writing, organising and maintaining your docs.
- 03
Sensible by default.
You shouldn’t need to become an expert in a documentation framework before you can document your project.
Write your Markdown. Configure what you need. Ship.
- 04
No baggage.
Every feature earns its place.
ctrl alt doc should solve the problems of documenting software without handing you a second project to maintain. Useful by default, configurable when you need it.
We don’t want you to think about the framework.