Skip to content
@PKUSoftwareEngineeringTeam

Allay Engine Develop Team

Allay Engine Develop Team

Building the Future of Static Blogging.


🚀 About Us & Our Mission

We are an open-source development team dedicated to creating simple, modern, and high-performance tools for content creators and developers.

Our core mission is to simplify the process of publishing beautiful personal blogs by leveraging modern technologies like Rust and Markdown. We strive to make blogging effortless and highly customizable.


✨ Our Core Projects

Here are the main projects and open-source assets maintained by our organization:

1. Allay Engine

A simple, highly configurable static site generator written in Rust.

Allay transforms your Markdown files into production-ready static HTML websites, focusing on speed and developer experience.

Status Language Issues Repository
CI Status Rust Open Issues Go to Allay

2. Axolotl Theme

The official, clean, and responsive default theme for the Allay Engine.

Repository
Go to Axolotl

3. Allay VS Code Extension

The official extension to enhance your Allay development workflow.

This extension provides seamless integration with Allay's features (e.g., autocompletion for template commands and metadata).

Repository
Go to VS Code Extension

🔑 Key Features of Allay

  • Markdown First: Write all your content using Markdown and optional Front-matter metadata (YAML or TOML supported) for configuration.
  • Fast by Design: Built on Rust for superior performance and concurrency.
  • Flexible Templating: Use custom commands (for, if, with, set) and substitutions ({:-}, {: :}) to build sophisticated layouts and dynamic pages.
  • Shortcodes & Includes: Easily embed reusable and dynamic content blocks within your Markdown using Shortcodes (e.g., {< note />}).
  • Live Preview: Develop with the built-in development server (allay server) which supports hot-reloading for immediate feedback on changes.
  • Customizable Layouts: Assign specific layouts (templates) to individual pages directly from the page's Front-matter.

💡 Get Started

To create your first blog with Allay, follow these quick steps:

  1. Install Allay: Follow the instructions on the Allay Engine GitHub Releases page or build from source.

  2. Initialize Your Site:

    allay new <my-blog-name>
    cd <my-blog-name>
  3. Start Developing:

    allay server

    Your blog will be available locally at http://localhost:8000.

🔗 Full Documentation: Read the full User Documentation


👋 Community & Contribution

We welcome contributions from everyone! Whether you are looking to fix a bug, suggest a new feature, or improve documentation, your help is appreciated.

  • Report Issues: Found a bug or have a feature idea for the Engine, Theme, or Extension? Please open an issue on the relevant repository's [Issue Tracker] (e.g., Allay Engine Issues).
  • Developers: Start with the Developer Documentation to understand the project structure and best practices.

📜 License

All projects are open-source. The specific license for each repository is listed below:

Project Name Description License
Allay Allay Blog Engine (Core) License
Allay_vscode VS Code Extension License
Axolotl Official default theme for Allay License
Axolotl-Wiki Demo for the Axolotl theme License

Pinned Loading

  1. Allay Allay Public

    Allay Blog Engine

    Rust 4

Repositories

Showing 5 of 5 repositories

Top languages

Loading…

Most used topics

Loading…