Deelan Documentation

What is Deelan?

Deelan (Data Engineering Electronic LAboratory Notebook) is a static-first knowledge management tool for technical individuals and teams. It is designed for people who want a durable, searchable, versioned knowledge base that stays close to plain text authoring and yet provides a useful, scaleable, and beautiful web-based view to navigate contents.

At a practical level, Deelan helps you:

• Write and maintain technical notes in markdown.
• Separate long-form writeups (post) from quick references (snippet).
• Search content with both simple filters and advanced query expressions.
• Keep traceable history through git timeline integration.
• Export selected content to self-contained HTML or PDF.
• Run fully offline with local assets and static-site behavior.

The project intentionally favors transparent files and reproducible build steps over opaque app-state storage. That makes it suitable for individuals, small teams, and internal engineering groups that want control over content, portability across environments, and predictable long-term maintenance.

If you are new to Deelan, start with the User Guide.
If you are integrating or automating workflows, use the CLI Reference.
If you are extending internals or build behavior, use the Developer Guide.
Take a look at the collection of advanced topics if anything piques your interest.

Choose a Track

• New users and authors:
  • Start in User Guide
• CLI usage and command flags:
  • Go to CLI Reference
• Build pipeline, internals, and maintenance:
  • Go to Developer Guide

Quick Decision Table

I want to...	Go to
Install and run Deelan quickly	Getting Started
Write posts/snippets with the right syntax	Authoring
Understand frontmatter fields and ID rules	Frontmatter
Configure timezone/themes/links	Configuration
Use the main deelan command	CLI Overview
Manage tags from CLI	Tag Management
Export to HTML/PDF	Export Contents
Understand search query syntax	Search Grammar
Work on build internals	Developer Notes