К основному содержанию
правило официальный · GitHub

markdown-content-creation — правило для GitHub Copilot

Задаёт стандарты вёрстки блоговых постов в Markdown: запрещает заголовки H1, требует строгий YAML front matter и форматирует списки с таблицами.

Установить в GitHub Copilot · Вручную: положить файлы Все способы и платформы ↓
.github/instructions/markdown-content-creation.instructions.md
Открыть на GitHub

Что делает markdown-content-creation

Правило применяется ко всем файлам **/*.md. Оно полностью запрещает заголовки H1, так как главный заголовок публикации формируется автоматически. Структура текста строится через ## для H2 и ### для H3. Если в тексте появляются H4 или H5, правило требует пересмотреть и упростить иерархию разделов. Вложенные списки требуют отступа ровно в два пробела, а блоки кода обязательно содержат метку языка.

Длина строк ограничена 400 знаками, при этом перенос рекомендуется делать на 80 символах. Блок YAML front matter должен содержать строгий набор полей: post_title, author1, post_slug, microsoft_alias, featured_image, categories, tags, ai_note, summary и post_date.

Без файла /categories.txt валидация категорий завершится с ошибкой, так как правило сверяет теги именно с этим списком.

Какие задачи решает

  • заполнить метаданные YAML front matter по чек-листу
  • исключить заголовки первого уровня в теле публикации
  • настроить явное указание языка для блоков кода
  • выровнять колонки таблиц и отступы во вложенных списках

Примеры запросов агенту

  • Оформи черновик статьи в Markdown по правилам репозитория и добавь front matter.
  • Проверь структуру заголовков в blog-post.md и переделай уровни ниже H3.

Как установить markdown-content-creation

Вручную: положить файлы

.github/instructions/markdown-content-creation.instructions.md

Поле applyTo задаёт, к каким файлам применять

По шагам, с командами для каждой платформы: AGENTS.md и CLAUDE.md: что это, кто читает и какой выбрать

Вопросы о markdown-content-creation

Как установить markdown-content-creation в GitHub Copilot?

Добавьте правило в файл .github/instructions/markdown-content-creation.instructions.md в корне вашего репозитория.

Почему нельзя использовать заголовки H1?

Заголовок первого уровня создаётся движком блога автоматически из метаданных статьи. В самом тексте структура должна начинаться с уровня ## (H2).

Откуда берутся допустимые категории для front matter?

Категории для поля categories должны в точности соответствовать списку в файле /categories.txt.

Исходный текст

markdown-content-creation.instructions.md · MIT
---
description: 'Markdown guidelines and content creation standards for blog posts'
applyTo: '**/*.md'
---

# Markdown Content Rules

The following markdown content rules are enforced in the validators:

1. **Headings**: Use appropriate heading levels (H2, H3, etc.) to structure your content. Do not use an H1 heading, as this will be generated based on the title.
2. **Lists**: Use bullet points or numbered lists for lists. Ensure proper indentation and spacing.
3. **Code Blocks**: Use fenced code blocks for code snippets. Specify the language for syntax highlighting.
4. **Links**: Use proper markdown syntax for links. Ensure that links are valid and accessible.
5. **Images**: Use proper markdown syntax for images. Include alt text for accessibility.
6. **Tables**: Use markdown tables for tabular data. Ensure proper formatting and alignment.
7. **Line Length**: Limit line length to 400 characters for readability.
8. **Whitespace**: Use appropriate whitespace to separate sections and improve readability.
9. **Front Matter**: Include YAML front matter at the beginning of the file with required metadata fields.

## Formatting and Structure

Follow these guidelines for formatting and structuring your markdown content:

- **Headings**: Use `##` for H2 and `###` for H3. Ensure that headings are used in a hierarchical manner. Recommend restructuring if content includes H4, and more strongly recommend for H5.
- **Lists**: Use `-` for bullet points and `1.` for numbered lists. Indent nested lists with two spaces.
- **Code Blocks**: Use triple backticks (```) to create fenced code blocks. Specify the language after the opening backticks for syntax highlighting (e.g., `csharp`).
- **Links**: Use `[link text](URL)` for links. Ensure that the link text is descriptive and the URL is valid.
- **Images**: Use `![alt text](image URL)` for images. Include a brief description of the image in the alt text.
- **Tables**: Use `|` to create tables. Ensure that columns are properly aligned and headers are included.
- **Line Length**: Break lines at 80 characters to improve readability. Use soft line breaks for long paragraphs.
- **Whitespace**: Use blank lines to separate sections and improve readability. Avoid excessive whitespace.

## Validation Checklist

Ensure compliance with the following validation requirements:

### Front Matter

- [ ] `post_title`: The title of the post.
- [ ] `author1`: The primary author of the post.
- [ ] `post_slug`: The URL slug for the post.
- [ ] `microsoft_alias`: The Microsoft alias of the author.
- [ ] `featured_image`: The URL of the featured image.
- [ ] `categories`: The categories for the post. These categories must be from the list in /categories.txt.
- [ ] `tags`: The tags for the post.
- [ ] `ai_note`: Indicate if AI was used in the creation of the post.
- [ ] `summary`: A brief summary of the post. Recommend a summary based on the content when possible.
- [ ] `post_date`: The publication date of the post.

### Content and Formatting

- [ ] Content follows the markdown content rules specified above.
- [ ] Content is properly formatted and structured according to the guidelines.
- [ ] Validation tools have been run to check for compliance with the rules and guidelines.

© github · MIT · github/awesome-copilot

Похожие правила IDE

Все правила IDE по теме «Тексты и документация» →

Из того же набора928

Весь набор →
memory-bank Правило заводит папку memory-bank/ с документацией проекта, чтобы Copilot подхватывал контекст заново после сброса сессии. ★ 40 418звёзд репо mcp-m365-copilot Задаёт правила разработки декларативных агентов и плагинов для Microsoft 365 Copilot на базе Model Context Protocol. Помогает настроить схему, авторизацию и карточки Adaptive Cards. ★ 40 418звёзд репо markdown Правило помогает GitHub Copilot писать и проверять Markdown-файлы по CommonMark 0.31.2. Оно применяется к файлам .md. ★ 40 418звёзд репо markdown-gfm Правило задаёт Copilot синтаксис GitHub Flavored Markdown, когда он пишет или проверяет файлы .md. Пригодится, если документация должна проходить рендер на GitHub без сюрпризов. ★ 40 418звёзд репо markdown-accessibility Правило проверяет Markdown-файлы на барьеры доступности и предлагает конкретные исправления. Пригодится для ревью документации и профилей GitHub. ★ 40 418звёзд репо lwc Задаёт стандарты разработки Lightning Web Components для Salesforce: файловую структуру, замену HTML на компоненты SLDS и правила реактивности. ★ 40 418звёзд репо langchain-python Правило для GitHub Copilot, которое подсказывает агенту паттерны LangChain: Runnable, LCEL, чат-модели, ретриверы и векторные хранилища. Пригодится, если вы пишете на Python с LangChain. ★ 40 418звёзд репо kubernetes-manifests Задаёт стандарты оформления манифестов Kubernetes для GitHub Copilot. Помогает генерировать безопасные конфигурации с готовыми лимитами ресурсов, пробами и метками. ★ 40 418звёзд репо

Спонсоры проекта

Компании, которые помогают держать аналитику открытой