Перейти к основному содержимому

마크다운 블로그를 만들 수 있는 오픈소스 프로젝트인데 주석도 지원하는게 뭐가 …

·561 слово·3 минут

Существует множество открытых решений, поддерживающих создание блогов на основе Markdown и функции комментариев (замечаний). Одним из примеров является платформа блогов на базе GitHub под названием fastpages, которая позволяет создавать блоги, написанные на Markdown, и реализует функции комментариев через открытую систему Utterances1.

Основные платформы и системы комментариев
#

Элемент Описание
Блоговый движок Различные инструменты для создания статических сайтов, такие как Jekyll, Eleventy, fastpages и др., могут быть использованы для создания блогов на основе Markdown.
Система комментариев - Utterances: Управляет комментариями с использованием GitHub-issues и может быть легко интегрирован, как в fastpages.
- Isso: Легкая система комментариев на Python, ориентированная на низкие требования к серверу и защиту конфиденциальности.
- Remark42: Система комментариев на языке Go, предлагающая чистый интерфейс, социальный вход и различные функции защиты от спама.
- Talkyard: Комплексная платформа для обсуждений с функциями комментариев, форумов и чатов.

Эти решения предоставляются как открытые и могут быть легко развернуты пользователями на собственных хостингах или с использованием контейнеров Docker234. В случае fastpages интеграция с GitHub Pages проста, что позволяет легко использовать основные функции комментариев1. В то же время, при использовании блогов на базе Eleventy или Jekyll можно выбрать одну из упомянутых систем комментариев для интеграции, что позволяет настроить их в соответствии с требованиями.

Резюме
#

Чтобы добавить функцию комментариев (замечаний) в блог, написанный на Markdown, вы можете использовать платформу, такую как fastpages, которая предоставляет встроенные функции комментариев (например, Utterances), или интегрировать отдельные системы комментариев, такие как Isso, Remark42, Talkyard, с инструментами создания статических сайтов, такими как Jekyll или Eleventy. Каждое решение имеет свои отличия в сложности установки, требованиях к серверу, защите конфиденциальности и т.д., поэтому следует выбирать то, что подходит именно под вашу среду эксплуатации и требования.

Таким образом, комбинируя различные открытые проекты и системы комментариев, вы можете легко реализовать функцию комментариев в блоге на базе Markdown.


Извините, нужная функция - это сноска
#

Если вы хотите реализовать функцию сносок (footnote) в документе Markdown, вы можете выбрать наиболее подходящий вариант из множества открытых решений. Например, если вы используете JavaScript-основной парсер Markdown markdown-it, то можете легко применить плагин markdown-it-footnote, описанный в 5. Этот плагин поддерживает как обычные, так и инлайн сноски, а синтаксис соответствует определению Pandoc5.

Основные варианты
#

Вариант Особенности Описание
markdown-it-footnote Плагин для markdown-it, JavaScript-основной Легко интегрируется с парсером Markdown в качестве плагина и поддерживает синтаксис обычных и инлайн сносок5
Jekyll (Kramdown) Статический генератор сайтов на Ruby, Kramdown встроен по умолчанию Kramdown поддерживает функции сносок, которые можно использовать без дополнительных плагинов67
Hugo (Goldmark) Статический генератор сайтов на Go, в последних версиях поддерживает сноски Встроенный движок Goldmark предлагает функции сносок с простым синтаксисом6
Eleventy (11ty) Статический генератор сайтов на JavaScript, настраиваемый пользователем Возможно добавление плагина сносок (например, markdown-it-footnote) при использовании markdown-it5

Пример использования markdown-it-footnote
#

Ниже приведен простой пример кода, использующего markdown-it и markdown-it-footnote:

const MarkdownIt = require('markdown-it');
const markdownItFootnote = require('markdown-it-footnote');

const md = new MarkdownIt().use(markdownItFootnote);

const result = md.render('Вот ссылка на сноску,[^1]\n\n[^1]: Вот сноска.');
console.log(result);

Этот код преобразует введенные в документе Markdown обозначения сносок в HTML и автоматически создает области сноски и ссылки5.

Резюме
#

Если вы хотите добавить функцию сносок в блог на Markdown, вы можете выбрать подходящее решение в зависимости от среды вашего проекта. Для проектов на базе JavaScript плагин markdown-it-footnote является очень полезным, а если вы используете статические генераторы на Ruby или Go, рассмотрите возможности Jekyll (Kramdown) или Hugo (Goldmark) соответственно567. Эти инструменты все открыты для настроек и легко адаптируются под ваши требования.