Xlog 📼 index

Friday 25 November 2022

📼 Xlog is a static site generator for digital gardening written in Go. It serves markdown files as HTML and allows editing files online. It focuses on enriching markdown files and surfacing implicit links between pages.

Xlog is a result of trying to build an offline personal knowledgebase with the ability to autolink pages together automatically. Without depending on proprietary file format or online service.

🏃 Quick Start

go install github.com/emad-elsaid/xlog/cmd/xlog@latest
mkdir new-site
cd new-site
xlog
# => Now browse to http://localhost:3000

Core Features

  • Serves any file from current directory
  • Any markdown is rendered to HTML format
  • Supports Github flavor markdown
  • Has a list of tools defined by extensions. triggered with Ctrl+K
  • Use image at the top of the page as a cover image
  • The first Emoji used in the page will be considered the icon of the page and displayed beside the title
  • Shows task list (Done/Total tasks) beside page link

Usecases

🏁 Getting started

📜 Principles

  • Uses the file system. No databases required
  • Minimal design and dependencies
  • Small core, flexible enough for developers to extend it.
  • Avoid add syntax to markdown, instead enhance how existing syntax is rendered

📖 Documentation

  • The README on Github will have basic usage and general information.
  • This website serves as end user documentation and developer entry point for developing extensions
  • There is also a Go package documentation that you can use to understand what xlog expose as public API

💡 Tutorials

Contributing

You can help Xlog in many ways:

  • Create a new extension
  • Improve the core codebase
  • Package it for different operating systems or different Linux distribution

🧑‍🤝‍🧑 Community

License

Xlog is released under MIT license