1 В избранное 0 Ответвления 0

OSCHINA-MIRROR/yue_plus-hexo-theme-arknights

Присоединиться к Gitlife
Откройте для себя и примите участие в публичных проектах с открытым исходным кодом с участием более 10 миллионов разработчиков. Приватные репозитории также полностью бесплатны :)
Присоединиться бесплатно
Клонировать/Скачать
README.md 23 КБ
Копировать Редактировать Web IDE Исходные данные Просмотреть построчно История
gitlife-traslator Отправлено 26.11.2024 18:40 b3715b0

hexo-theme-arknights

Предварительный просмотр

Если вы используете эту тему, пожалуйста, разместите здесь ссылки на предварительный просмотр.

Изображение предварительного просмотра темы

Установка

Среда

Создание проекта блога с помощью hexo-cli:

hexo init Hexo
cd Hexo
cnpm install
git clone https://github.com/Yue-plus/hexo-theme-arknights.git themes/arknights

Установка зависимостей

Для пользователей npm:

cnpm install hexo-server hexo-browsersync hexo-renderer-pug --save

Для пользователей yarn:

yarn add hexo-server hexo-browsersync hexo-renderer-pug

Изменение конфигурации файла

  • Обратитесь к Hexo веб-сайту, чтобы изменить файл конфигурации _config.yml в каталоге Hexo/.

    • Измените значение по умолчанию theme: landscape на arknights

    • Включите подсветку кода:

      highlight:
        hljs: true
  • Скопируйте файл _config.arknights.yml в каталог Hexo/ и переименуйте его в _config.arknights.yml.

Рекомендуется обратиться к следующим разделам:

Конфигурационный файл темы можно изменить, следуя китайским комментариям.

Модификация файлов ресурсов

Вы можете добавить следующие файлы в каталог Hexo/source/ по мере необходимости:

  • CNAME: Пользовательский домен для GitHub Pages
  • img/ каталог содержит Alipay.png и WeChat.png, которые являются вашими собственными QR-кодами для оплаты (соотношение сторон 1:1, высокое разрешение не отображается)

Файлы в каталоге Hexo/themes/arknights/source/ можно изменять по мере необходимости:

  • favicon.ico: значок браузера на вкладке (64*64, разрешение слишком высокое, чтобы отображаться)
  • README.md: README для развертывания репозитория

Написание статей

  • См. раздел Написание | Hexo.

  • В ветке Hexo репозитория темы есть несколько примеров текстов, которые можно использовать

  • Добавьте теги и категории к статьям, дополнительные функции см. в разделе Hexo | Front-matter, пример:

    ---
    title: 'Hello World !'
    date: 2020-04-15 21:54:02
    tags: code
    category: Example
    ---
  • Текст перед «» называется резюме, которое будет отображаться на главной странице и может быть настроено так, чтобы также отображаться в основном тексте.

Добавление страниц в навигационную панель

  • Например, создайте страницу about
  • Выполните команду hexo new page 'about' в каталоге Hexo/
  • Каталог Hexo/source/ теперь будет содержать папку about
  • Отредактируйте файл Hexo/source/about/index.md

  • Отредактируйте файл _config.arknights.yml, добавьте ссылку:

    menu:
      About: /about

Запрет перехода на страницы архива

Этот параметр находится примерно в строке 88 файла конфигурации Hexo _config.yml.

# Pagination
## Set per_page to 0 to disable pagination
per_page: 10
pagination_dir: page

Измените per_page: на 0.

Система комментариев

Valine

Эта тема поддерживает Valine. См. раздел Быстрый старт Valine для изменения файла конфигурации Hexo _config.arknights.yml:

valine:
  enable: false
  app_id: # APP ID
  app_key: # APP KEY
  server_url: # APP DOMAIN(LeanCloud 国际版)

Включите уведомления по электронной почте: zhaojun1998 / Valine-Admin

Примечание! Если вы используете LeanCloud International Edition, вам необходимо настроить server_url: . Этот параметр можно найти в разделе «Настройки» > «Приложение» > «Домены API» > «Запрос домена» в приложении LeanCloud, добавив префикс https:// к домену, заканчивающемуся на .api.lncldglobal.com.

Gitalk

Эта тема поддерживает Gitalk. См. gitalk/readme-cn.md для редактирования файла конфигурации Hexo _config.arknights.yml:

gitalk:
  enable: false
  client_id: # GitHub 应用 Client ID
  client_secret: # GitHub 应用 Client Secret
  repo: # 用于存放评论数据的 GitHub 仓库
  owner: # 该 GitHub 仓库所有者
  admin: [] # 具有写该 GitHub 仓库权限的用户
            # 例如: [adminA,adminB]
  id: # (可选) 页面的唯一标识
      # 例如: location.pathname

Waline

Эта тема поддерживает Waline . См. официальную документацию Waline для редактирования файла конфигурации Hexo _config.arknights.yml:

waline:
  enable: false **Сервер_урл:** # Server_Url

**Artalk**

Данная тема поддерживает Artalk.

Пожалуйста, обратитесь к официальному документу Artalk для изменения файла `_config.arknights.yml` в каталоге Hexo:

```yaml
artalk:
  enable: false
  server: https://artalk.server.instance/ # Ваш адрес службы Artalk
  site_name: My Blog # Название сайта, используется для различения нескольких сайтов (необязательно)

Математические формулы

Эта тема поддерживает два метода отображения математических формул:

  1. Метод один: статическое рендеринг

Вы можете использовать Hexo-фильтр-mathjax для статического рендеринга и отображения математических формул.

Рекомендуется сначала заменить рендерер Markdown на hexo-renderer-pandoc, который лучше обрабатывает математические формулы.

  1. В каталоге Hexo выполните следующие команды:

    # Установить плагин hexo-filter-mathjax
    cnpm install hexo-filter-mathjax --save
    # Очистить кэш
    hexo clean
  2. Добавьте следующее содержимое в файл _config.yml:

    mathjax:
      tags: none # или 'ams' или 'all'
      single_dollars: true # Включить одиночный знак доллара в качестве встроенного разделителя математических формул
      cjk_width: 0.9 # Относительная ширина CJK символов
      normal_width: 0.6 # Относительная нормальная ширина
      append_css: true # Добавить CSS на каждую страницу
      every_page: false # Если true, каждая страница будет отображаться с помощью mathjax независимо от настройки `mathjax` в заголовке статьи
  3. Добавьте mathjax: true в раздел Front-matter статьи, которую вы хотите включить mathjax:

    ---
    title: On the Electrodynamics of Moving Bodies
    categories: Physics
    date: 1905-06-30 12:00:00
    mathjax: true
    ---

Затем вы можете использовать синтаксис LaTeX в статье.

  1. Обратите внимание, что встроенные математические формулы ($...$) не должны иметь пробелов перед началом ($) и после конца ($). Например:

    - $ \epsilon_0 $
    + $\epsilon_0$
    - $ \frac{\partial}{\partial t} $
    + $\frac{\partial}{\partial t}$
  2. Обратите внимание на конфликты между LaTeX и Markdown. При необходимости используйте \ для экранирования:

    - $\epsilon_0$
    + $\epsilon\_0$
    - \begin{eqnarray*}
    + \begin{eqnarray\*}
  1. Способ два: динамический рендеринг

Тема также поддерживает MathJax, динамически отображая формулы во время просмотра пользователем:

  1. Сначала удалите встроенный рендерер Hexo hexo-renderer-marked и замените его на hexo-renderer-kramed, который лучше поддерживает MathJax:

    npm uninstall hexo-renderer-marked --save
    npm install hexo-renderer-kramed --save
  2. Измените файл _config.arknights.yml в каталоге Hexo:

      # Поддержка формул
      mathjax:
    -   enable: false
    +   enable: true
      version: '2.6.1'  # Важно
  3. Затем вы можете использовать синтаксис LaTeX в статьях:

    % Однострочная встроенная формула
    % Обратите внимание, что обе стороны должны быть заключены в "`" , и не должно быть пробелов между "` " и "$"
    `$\sigma$`
    
    % Многострочная формула
    $$
    \begin{aligned}f(x) &= \sum_{i=1}^{\infty}{\frac{x}{2^i}} \\
    &= x\end{aligned}
    $$
  4. С помощью этого метода вам не нужно экранировать синтаксис LaTeX. Следующие формулы можно использовать напрямую без каких-либо проблем:

    \epsilon_0
    \begin{eqnarray*}

Hexo-рендерер-kramed имеет другие настраиваемые параметры, пожалуйста, обратитесь к документации плагина: https://github.com/sun11/hexo-renderer-kramed

У каждого метода есть свои преимущества и недостатки:

  • Динамический рендеринг не требует экранирования синтаксиса LaTeX, лучше поддерживает экспорт Markdown из других мест. Однако из-за необходимости рендеринга в браузере отображение страницы может немного задерживаться.
  • Статический рендеринг непосредственно компилирует формулы в статические файлы, обеспечивая лучшее отображение, но требует экранирования синтаксиса.
  • hexo-renderer-pandoc быстро отображает формулы без необходимости экранирования, но требуется установить Pandoc.

Поддержка диаграмм

Измените файл _config.arknights.yml в каталоге Hexo:

  # Поддержка диаграмм
  mermaid:
-   enable: false
+   enable: true
    version: '8.13.5'

Тема использует mermaid-js для рисования различных диаграмм. См. примеры

Поддерживает: Flowchart | Sequence Diagram | Class Diagram | State Diagram | Entity Relationship Diagram | User Journey Diagram | Gantt Chart | Command Diagram | Pie Chart

Синтаксис:

<div class="mermaid">
  graph LR
  A[Hard edge] -->|Link text| B(Round edge)
  B --> C{Decision}
  C -->|One| D[Result one]
  C -->|Two| E[Result two]
</div>

Если вы привыкли использовать блоки кода, это тоже полностью поддерживается.

Подсчёт слов и времени чтения

Зависит от... hexo-wordcount:

npm пользователи:

cnpm install hexo-wordcount --save

yarn пользователи:

yarn add hexo-wordcount

После этого измените файл _config.arknights.yml в каталоге Hexo:

post:
  count: true # показывать ли статистику количества слов
  time: true # показывать ли статистику времени чтения

Статистика просмотров

Используйте незубрик для сбора статистики просмотров.
Чтобы включить эту функцию, измените файл _config.arknights.yml в каталоге Hexo и добавьте:

busuanzi:
  enable: false
  sitePV: true # статистика общего количества просмотров сайта
  siteUV: true # количество уникальных посетителей сайта
  pagePV: true # статистика просмотров страниц

Шифрование документов

В файле Hexo/_config.yml добавьте следующее:

# Security
encrypt: # hexo-blog-encrypt
  abstract: чтобы подключиться к Rhodes Island™ нужно ввести пароль
  message: введите пароль для подключения к Rhodes Island™:
  tags:
  - {name: tagName, password: 密码A}
  - {name: tagName, password: 密码B}
  wrong_pass_message: пароль для Rhodes Island™ неверен, попробуйте ещё раз.
  wrong_hash_message: пароль для Rhodes Island™ неверен, сейчас можно просматривать с временными правами доступа.

Или установите настройки в области Front-matter статьи:

---
title: Hello World
tags:
- шифрование дневника
date: 2016-03-30 21:12:21
password: mikemessi
abstract: чтобы подключиться к Rhodes Island™, нужен пароль
message: введите пароль для подключения к Rhodes Island™:
wrong_pass_message: пароль для Rhodes Island™ неверен, попробуйте ещё раз.
wrong_hash_message: пароль для Rhodes Island™ неверен, сейчас можно просматривать с временными правами доступа.
---

Поиск

Поиск включён по умолчанию. Чтобы отключить его, в файле Hexo/_config.arknights.yml установите:

search:
  enable: false

Front-matter

Помимо поддержки Front-matter Hexo, также поддерживаются:

# дата публикации/обновления в правом верхнем углу статьи
post-info: true/false

# каталог в боковой панели
post-index: true/false

# окно вознаграждения
reward: true/false

Импорт пользовательских CSS/JS файлов

Вы можете разместить свои файлы CSS в папке source/css/ и файлы JavaScript в папке source/js/.
Затем измените файл Hexo/_config.arknights.yml:

  # импортировать таблицы стилей в тег <head>
  stylesheets:
+ - /css/custom.css
  
  # импортировать скрипты в конец тега <body>
  scripts:
+ - /js/custom.js

Ресурсная папка предназначена для хранения пользовательских ресурсов. Все файлы и папки, начинающиеся с символа подчёркивания (_), кроме папки _posts, а также скрытые файлы будут игнорироваться. Файлы Markdown и HTML будут обработаны и помещены в папку public, а остальные файлы будут скопированы.

— из официальной документации Hexo

Участие в разработке

Добро пожаловать в Issues и PR.

Ветви

Ветвь Описание
main относительно стабильная версия
gh-pages хостинг gh-страниц
hexo каталог Hexo, здесь есть файлы .md, которые можно использовать для тестирования темы

Проблемы, которые могут возникнуть во время разработки, и способы их решения

Модификации в файлах TS не вступают в силу

TypeScript требует ручной компиляции. Установите typescript глобально, затем перейдите в каталог arknights\source\js\_src и выполните команду tsc для компиляции.

При запуске hexo serve --debug длинные статьи отображаются не полностью

Это вызвано плагином горячей перезагрузки hexo-browsersync, который не влияет на публикацию.
Решение: отключите этот плагин. (В любом случае это не повлияет на публикацию, так что всё равно.)

Документы, которые могут потребоваться для разработки

Также обратитесь к нескольким блогам известных авторов:

Вкладчики

Опубликовать ( 0 )

Вы можете оставить комментарий после Вход в систему

1
https://api.gitlife.ru/oschina-mirror/yue_plus-hexo-theme-arknights.git
git@api.gitlife.ru:oschina-mirror/yue_plus-hexo-theme-arknights.git
oschina-mirror
yue_plus-hexo-theme-arknights
yue_plus-hexo-theme-arknights
main