XLog

XLog is a fast static site generator designed for creating knowledge bases, specifically optimized for digital gardens and personal wikis. Crafted in Go, XLog leverages 37 built-in extensions that enhance user experience with features such as backlinks, hashtags, and a powerful search function.

Key Features

• High Performance: Built with Go, XLog renders extensive knowledge bases in just seconds.
• Live Preview: An embedded web server offers instant updates with hot-reload functionality.
• Interconnected Notes: Automatically generates backlinks and establishes bidirectional relationships between pages.
• Extensibility: Comes with 37 built-in extensions for adding diverse functionalities—photos, todos, search capabilities, and more.
• Git-Native Architecture: Utilizes a filesystem-based approach, making it compatible with any text editor and version control system.
• Versatile Output Options: Supports local serving or the generation of static sites for broader deployment.

Quick Start Example

go install github.com/emad-elsaid/xlog/cmd/xlog@latest
mkdir my-notes
cd my-notes
echo "# Hello World" > index.md
xlog
# => Browse to http://localhost:3000

Use Cases

• Personal Wiki: Build interconnected notes that facilitate easy navigation through automatic backlinks.
• Research Organization: Efficiently manage research papers, citations, and ideas.
• Team Documentation: Create comprehensive team knowledge bases and project documentation.
• Learning Journal: Keep study notes organized with hashtags and a search feature.
• Digital Garden: Share knowledge publicly or privately in an organized manner.

How It Works

1. Write: Utilize any text editor (e.g., Vim, Emacs, VS Code) to create Markdown files.
2. Preview: Start the live preview server using the xlog command with hot-reload functionality.
3. Enhance: XLog includes automatic backlinking, hashtagging, and search enhancements.
4. Deploy: Generate a static site using xlog -build output/ for deployment.

XLog runs a web server that monitors markdown files for changes. The browser interface includes an "Edit" button that opens the file in the configured editor. Any saved changes are instantly reflected in the browser.

Competitive Advantages

• Versus Other Generators: XLog adds unique knowledge-base features like backlinks and search right out of the box.
• Versus Cloud Solutions: It is self-hosted, privacy-conscious, and available offline without any costs.
• Versus Commercial Tools: Open-source and customizable, XLog integrates smoothly with existing workflows and supports Markdown.

Documentation and Extensions

For more guidance, comprehensive documentation is available:

• Installation Guide
• Usage Instructions
• Available Extensions
• Static Site Creation
• Writing Extensions Tutorial
• API Documentation

XLog comes pre-loaded with an array of extensions that significantly enhance its utility for knowledge management. This includes features for backlinks, hashtags, full-text search, along with rich content capabilities like photo management and mathematical notation support.

Contributing to XLog by creating new extensions or improving existing features is welcomed, fostering a community-driven approach to its development.