DOCSEARCHbyAlgolia
Submit Docs

Halo-Plus Documentation

website·Indexed 32 days ago

https://docs.halo-plus.nineya.com/

Documentation for Halo-Plus, a modern open-source blog and CMS system. Includes guides for installation via Docker, Docker Compose, Linux, and Windows, as well as developer documentation for theme creation using FreeMarker, template tags, and system configuration. Covers versions 1.0 and 1.1-SNAPSHOT.

Tokens
34K
Snippets
187
Records
282
Agent score
51%

What's inside Halo-Plus

  1. Overview of Halo-Plus Markdown Rendering

    Starting from version 1.0.0, Halo-Plus saves documents as rendered HTML by default. It uses the markdown-it library for rendering, wrapped in the @halo-dev/markdown-renderer package to ensure consistent output across the platform. The base syntax follows the CommonMark specification.

  6. Understand Halo-Plus system architecture

    The Halo-Plus blog system consists of four main components:

    1. halo: The core system service developed with Spring Boot.
    2. halo-admin: The backend management interface developed with Vue (integrated into the Halo-Plus runtime package, no independent deployment required).
    3. halo-comment-dream: A comment plugin developed with Vue, integrated into themes via a JavaScript file.
    4. halo-theme-dream: A collection of blog themes written using the FreeMarker template engine.

  7. Understand Halo-Plus Markdown rendering

    Starting from version 1.0.0, Halo-Plus saves documents as rendered HTML by default. It uses the markdown-it library for rendering, specifically wrapped in the @halo-dev/markdown-renderer package to ensure consistent rendering results across the platform.

  8. Understand Halo-Plus system architecture

    The Halo-Plus blog system consists of four primary components:

    1. halo: The core system service developed with Spring Boot.
    2. halo-admin: The backend management rendering engine developed with Vue (integrated into the Halo-Plus runtime package).
    3. halo-comment-dream: A comment plugin developed with Vue, integrated into themes via JavaScript files.
    4. halo-theme-dream: A collection of blog themes written using the FreeMarker template engine.

  12. Contribute code to Halo-Plus via Git

    Follow these steps to set up your local environment and submit code changes to the Halo-Plus project:

    1. Fork the repository on GitHub.
    2. Clone your fork locally using the --recursive flag to ensure submodules are initialized.
    3. Add the upstream remote to keep your local copy synced with the main project.
    4. Create a development branch based on the upstream master branch.
    5. Commit and push your changes to your origin fork.
    6. Sync with master by merging the upstream master branch into your feature branch before submitting a Pull Request.
    # 2. Clone the fork
git clone https://github.com/{YOUR_USERNAME}/halo-plus --recursive

# 3. Add upstream and fetch
git remote add upstream https://github.com/nineya/halo-plus.git
git fetch upstream master

# 4. Create development branch
git checkout upstream/master
git checkout -b {BRANCH_NAME}

# 5. Commit and push
git add .
git commit -s -m "Fix a bug king"
git push origin {BRANCH_NAME}

# 6. Sync with upstream master before PR
git fetch upstream/master
git merge upstream/master
git push origin {BRANCH_NAME}