mirror of
https://github.com/github/awesome-copilot.git
synced 2026-04-11 18:55:55 +00:00
b1537c6d96
* CHANGE: Update markdown instructions and add new files - Added new markdown content creation guidelines. - Introduced GitHub Flavored Markdown (GFM) instructions. - Updated CommonMark Markdown instructions with detailed rules. - Removed redundant content from the original markdown instructions. * CHANGE: Update markdown content guidelines - Refine code block formatting instructions in markdown content creation guidelines. - Add detailed HTML block types for GitHub-flavored markdown.
3.2 KiB
3.2 KiB
description, applyTo
| description | applyTo |
|---|---|
| Markdown guidelines and content creation standards for blog posts | **/*.md |
Markdown Content Rules
The following markdown content rules are enforced in the validators:
- 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.
- Lists: Use bullet points or numbered lists for lists. Ensure proper indentation and spacing.
- Code Blocks: Use fenced code blocks for code snippets. Specify the language for syntax highlighting.
- Links: Use proper markdown syntax for links. Ensure that links are valid and accessible.
- Images: Use proper markdown syntax for images. Include alt text for accessibility.
- Tables: Use markdown tables for tabular data. Ensure proper formatting and alignment.
- Line Length: Limit line length to 400 characters for readability.
- Whitespace: Use appropriate whitespace to separate sections and improve readability.
- 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 and1.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
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.