В любом случае, есть ли шаблон Markdown?

У меня есть контент знаний, который мне нужно сохранить в репозитории GitHub. Содержимое составляет около 40 файлов (сейчас в 40 документах). Все они представляют собой одностраничный файл. Они имеют общую структуру:

Проблема

Немного аннотации

Параметры

какая-то реклама

Рекомендация

Немного аннотации

Если я запишу 40 файлов md (скопирую/вставлю структуру и заполню аннотации), я рискую позже столкнуться с проблемой структуры, требующей небольшого изменения - например, переименования «Рекомендации» в «Решение» или некоторых других деталей форматирования. Мне пришлось бы перебрать 40 файлов только для форматирования.

Должен быть лучший способ.

Например, есть ли способ определить шаблон файла md в одном месте, а затем создать 40 файлов md, которые содержат содержимое, но не обязательно в формате. Тогда есть что-то, что визуализирует эти файлы с использованием шаблона?

Можно ли вместо этого использовать сетку уценки или содержимое будет слишком большим для ячеек?

Arnaud Flaesch 30.04.2024 22:24

Спасибо за мысль, но иногда содержание будет большим. Кроме того, работа с таблицами уценок — это кошмар, если честно, с большим контентом (вы знаете, каналы и все такое). Таблица HTML — еще один вариант, но я пытаюсь использовать маршрутизатор, чтобы иметь мини-удобоваримые файлы md для каждой записи.

sOltan 30.04.2024 22:37

Возможно, я слишком много думаю и переусердствую. Чем больше я об этом думаю, тем больше понимаю, что то, о чем я прошу, вероятно, не стоит делать. Если со временем структура изменится, какое бы решение ни существовало, оно все равно придется изменить во многих местах. ИИ предложил мне иметь шаблон файла md с заполнителями и сценарий Python для чтения содержимого структуры из json, и этот сценарий генерирует файлы md. Я просто думаю, что это, вероятно, того не стоит, поскольку 40-страничный контент придется хранить в файлах json.

sOltan 30.04.2024 22:48

Кажется слишком сложным, да, жаль, что в Markdown нет шаблонов.

Arnaud Flaesch 30.04.2024 23:18
Стоит ли изучать PHP в 2026-2027 годах?
Стоит ли изучать PHP в 2026-2027 годах?
Привет всем, сегодня я хочу высказать свои соображения по поводу вопроса, который я уже много раз получал в своем сообществе: "Стоит ли изучать PHP в...
Поведение ключевого слова "this" в стрелочной функции в сравнении с нормальной функцией
Поведение ключевого слова "this" в стрелочной функции в сравнении с нормальной функцией
В JavaScript одним из самых запутанных понятий является поведение ключевого слова "this" в стрелочной и обычной функциях.
Приемы CSS-макетирования - floats и Flexbox
Приемы CSS-макетирования - floats и Flexbox
Здравствуйте, друзья-студенты! Готовы совершенствовать свои навыки веб-дизайна? Сегодня в нашем путешествии мы рассмотрим приемы CSS-верстки - в...
Тестирование функциональных ngrx-эффектов в Angular 16 с помощью Jest
В системе управления состояниями ngrx, совместимой с Angular 16, появились функциональные эффекты. Это здорово и делает код определенно легче для...
Концепция локализации и ее применение в приложениях React ⚡️
Концепция локализации и ее применение в приложениях React ⚡️
Локализация - это процесс адаптации приложения к различным языкам и культурным требованиям. Это позволяет пользователям получить опыт, соответствующий...
Пользовательский скаляр GraphQL
Пользовательский скаляр GraphQL
Листовые узлы системы типов GraphQL называются скалярами. Достигнув скалярного типа, невозможно спуститься дальше по иерархии типов. Скалярный тип...
0
4
245
1
Перейти к ответу Данный вопрос помечен как решенный

Ответы 1

Ответ принят как подходящий

Я рискую позже столкнуться с проблемой структуры, требующей небольшого изменения - например, переименования «Рекомендации» в «Решение» или некоторых других деталей форматирования. Мне пришлось бы перебрать 40 файлов только для форматирования.

Вам всегда нужно будет выбрать определенную структуру для ваших данных.

Идея шаблонизации состоит в том, чтобы отделить представление от данных. Любое шаблонное решение должно будет считывать свои данные из некоторого формата данных (например, JSON), и там вам также придется определить свои ключевые имена. Есть ли у вас:

  1. поле JSON "recommendation":,
  2. заголовок уценки ## Recommendation или
  3. HTML-заголовок <h2>Recommendation</h2>

Это не имеет значения. Во всех трех форматах вам необходимо выбрать имя поля (в данном случае рекомендуется) и определить структуру (даже если вы не применяете ее с помощью схемы или валидатора, структура все равно существует, чтобы данные были полезны). И во всех трёх случаях позже можно написать скрипт для автоматического изменения названия поля или заголовка.

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

Другие вопросы по теме