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
- 01Heading and section spacing rules
- 02Torchlight code block flags
- 03Language tags for code fences
- 04List and table conventions
- 05Horizontal rule guidance
Use cases
- 01Formatting documentation pages
- 02Adding syntax-highlighted code examples
- 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-formattingAfter installing, type/markdown-formattingin Claude Code to confirm it loaded.
Details
From the project READMEGeneral
- 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.
| Flag | Description |
|---|---|
+code | Source code only (syntax highlighted) |
+demo | Preview + code (always visible) |
+demo-folded | Preview + code + collapsible |
Other flags (+preview, +collapse, output) exist but are less common — only use when requested.
Language Tags
| Use For | Tag |
|---|---|
| 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 stylingpreview-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.
| Column | Type | Nullable | Default |
|---|---|---|---|
| id | bigint | No | AUTO |
| name | varchar(255) | No | - |
Linting
- Blank line before and after headings, code blocks, and lists
- No trailing spaces
- Single blank line between sections — not double