mcpField
M
markdown-formatting

markdown-formatting

github.com/naykel76Documents0103 installsUpdated 2d ago
Repository

About markdown-formatting

A formatting skill for writing Markdown documents, with conventions for code fences, lists, tables, headings, and separators. It is intended for authors who need consistent formatting and Torchlight-specific code block flags.

Key features

  1. 01Heading and section spacing rules
  2. 02Torchlight code block flags
  3. 03Language tags for code fences
  4. 04List and table conventions
  5. 05Horizontal rule guidance

Use cases

  1. 01Formatting documentation pages
  2. 02Adding syntax-highlighted code examples
  3. 03Preparing consistent lists and tables

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/naykel76/skills-and-guidelines --skill markdown-formatting

After installing, type/markdown-formattingin Claude Code to confirm it loaded.

Details

From the project README

General

  • No table of contents unless specifically requested.
  • Don't join two thoughts mid-sentence with an em dash or a colon. Use a new sentence, or a comma with a linking word ("because", "so").

Code Blocks

All code blocks must include a language tag and a Torchlight flag.

FlagDescription
+codeSource code only (syntax highlighted)
+demoPreview + code (always visible)
+demo-foldedPreview + code + collapsible

Other flags (+preview, +collapse, output) exist but are less common — only use when requested.

Language Tags
Use ForTag
Directory trees, shell commands```bash +code
Blade templates```html +code-blade
Demo-Folded Attributes

When using +demo-folded, apply demo attributes intentionally:

  • class="..." — outer demo wrapper styling
  • preview-class="..." — preview-only layout or styling

Example opening tag:

```html +demo-folded class="bx" preview-class="grid gap lg:cols-3"
<div class="example">Content here</div>

Horizontal Rules

Use 80 hyphens as a visual section separator in long documents when a --- thematic break is not appropriate:

--------------------------------------------------------------------------------

Lists

  • Use hyphens - for unordered lists
  • Use 1. 2. for ordered steps
  • 4-space indentation for nested items

Tables

Standard GitHub Flavored Markdown. Keep column separators aligned.

ColumnTypeNullableDefault
idbigintNoAUTO
namevarchar(255)No-

Linting

  • Blank line before and after headings, code blocks, and lists
  • No trailing spaces
  • Single blank line between sections — not double

Comments

Markdown supported