Простой удобный инструмент для создания статических блогов

Особенности:

• Нет информации о категориях;
• Не различает страницы и статьи;
• Использует только метки для классификации статей;
• Может генерировать данные RSS, Atom и Sitemap;
• Архивные страницы можно классифицировать по месяцам и годам;
• В качестве основного шаблона использует шаблоны Go;
• Можно указать выделение кода в шаблоне;
• Создаёт статические данные TOC.

Установка

Пользователи macOS и Linux могут установить напрямую с помощью brew:

brew tap caixw/brew
brew install caixw/brew/blogit

Для других популярных платформ можно скачать с https://github.com/caixw/blogit/releases и поместить двоичный файл в PATH.

Если на вашей платформе нет двоичного файла, вы можете скомпилировать его самостоятельно:

git clone https://github.com/caixw/blogit.git
cd blogit
./build.sh

Docker

В настоящее время docker управляется одновременно на docker.io и ghcr.io, вы можете получить соответствующий контейнер следующим образом:

docker pull docker.io/caixw/blogit:latest

docker pull ghcr.io/caixw/blogit:latest

Использование

Команда blogit init dir может напрямую создать полную систему блога. Для получения подробной информации см. USAGE.

GitHub action

Если ваш сайт развёрнут на GitHub, вы можете использовать action для полной автоматизации компиляции и загрузки кода.

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - name: checkout source
      uses: actions/checkout@v2
      with:
        repository: owner/src
        path: src/

    - name: checkout dest
      uses: actions/checkout@v2
      with:
        repository: owner/dest
        path: dest/
        persist-credentials: false # github-push-action@master 需要这个
        fetch-depth: 0 # # github-push-action@master 需要这个

    - name: build static site
      uses: caixw/blogit@master
      with:
        src: src
        dest: dest

    - name: commit files
      uses: EndBug/add-and-commit@v7
      with:
        author_name: github-actions
        author_email: 41898282+github-actions[bot]@users.noreply.github.com
        cwd: dest/
        push: false
        message: 'docs: add changes'

    - name: push changes
      uses: ad-m/github-push-action@master
      with:
        directory: dest/
        github_token: ${{ secrets.GITHUB_TOKEN }} # 确保有相应的权限
        branch: ${{ github.ref }}

secrets.GITHUB_TOKEN связан с PAT, который должен иметь разрешение на запись в репозиторий owner/dest.

Параметры