2 min read Edit page

Welcome to Diplodocs 🦕

Diplodocs is an opinionated, batteries-included documentation engine. Colossal power, zero configuration.


Why Diplodocs?

Some documentation engines require wrangling Python environments, pip packages, virtualenvs, and 60+ lines of YAML configuration just to get a basic site running.

Diplodocs replaces the dependency sprawl and plugin clutter with a single fast binary — zero Python runtime, zero npm packages, and zero boilerplate:

  • 🚀 Zero-Config Defaults: Point Diplodocs at your docs/ folder and start.
  • ⚡ Native Modern Markdown: GitHub callouts, code tabs, and mermaid diagrams work without third-party plugins.
  • 📂 Filesystem Navigation: Automatic section hierarchies with natural ordering.
  • 🤖 Agent-Ready (/llms.txt): Generates structured context files for AI coding assistants.
  • 🔍 Instant Offline Search: Pre-indexed fuzzy search out of the box with Ctrl+K.

Interactive Feature Preview

Callouts / Admonitions

Note

This note rendered with standard GitHub Markdown syntax. No special plugins required.

Tip

Prefer three-bang syntax? Diplodocs also natively supports !!! note "Title" admonitions without needing third-party extensions.

Warning

Breaking changes or critical warnings grab attention immediately.

Code Tabs

go
package main

import "fmt"

func main() {
    fmt.Println("Hello from Diplodocs! 🦕")
}
python
def main():
    print("Hello from Diplodocs! 🦕")

if __name__ == "__main__":
    main()
javascript
console.log("Hello from Diplodocs! 🦕");