Przejdź do treści
Biblioteka skilli
Dokumenty i biuro · Pisanie

markdown-authoring

/markdown-authoring

Pisze dokumentację Markdown o deterministycznej strukturze, zgodną z lintem i zintegrowaną z CI: pliki README, strony dokumentacji, naprawa błędów markdownlint, reguły stylu i kontrole w pre-commit i potokach.

Repozytorium
tekhne ↗
Licencja
MIT
Ostatnia zmiana repozytorium
21.10.2026

Ocena i bezpieczeństwo

100/ 100Klasa: dobry
Format25 / 25
Frontmatter z nazwą i opisem, poprawna nazwa, opis do 1024 znaków, nazwa zgodna z folderem.
Odkrywalność25 / 25
Opis mówi, kiedy użyć skilla, ma sensowną długość i jest w 3. osobie.
Treść35 / 35
Co najmniej 150 słów i do 500 linii, nagłówki, listy kroków, przykłady albo kod.
Higiena15 / 15
Bez zaślepek typu TODO, bez ścieżek Windows, z licencją.
Ryzykobrak sygnałów w skanie
Pliki w paczce
63
Skrypty
1
Komentarze HTML
0
Adresy URL w SKILL.md
0
Przestarzałość

Brak sygnałów. Repozytorium zmienione 21.10.2026, bez odwołań do wycofanych modeli i API.

Licencja

MIT, otwarta: można używać i zmieniać, z zachowaniem informacji o autorze.

Co sprawdzić przed instalacją
  • 1 skrypt w paczce. Przejrzyj je przed instalacją, bo Claude może je uruchomić.

Skrypty: scripts/read-reference.sh

Co robi i kiedy

Pisze dokumentację Markdown o deterministycznej strukturze, zgodną z lintem i zintegrowaną z CI: pliki README, strony dokumentacji, naprawa błędów markdownlint, reguły stylu i kontrole w pre-commit i potokach.

Oryginalny opis (EN)

Author high-quality Markdown documentation with deterministic structure, lint compliance, and CI integration. Use when writing README files, creating docs pages, fixing markdownlint failures, defining style rules, or wiring markdown checks into pre-commit and pipelines. Keywords: markdown, markdownlint, readme, docs, headings, lists, code fences, links, images, lint config, ci, documentation style.

Jak działa

  1. When to Use
  2. When Not to Use
  3. Principles
  4. Deterministic Workflow
  5. Quick Commands
  6. Anti-Patterns
  7. References
Sekcje z nagłówków SKILL.md, w oryginale · 136 linii, 553 słów
Podgląd SKILL.md
---
name: markdown-authoring
description: "Author high-quality Markdown documentation with deterministic structure, lint compliance, and CI integration. Use when writing README files, creating docs pages, fixing markdownlint failures, defining style rules, or wiring markdown checks into pre-commit and pipelines. Keywords: markdown, markdownlint, readme, docs, headings, lists, code fences, links, images, lint config, ci, documentation style."
---

# Markdown Authoring

## When to Use

Use this skill when the task involves Markdown content, linting, or documentation standards.

## When Not to Use

Do not use this skill for non-Markdown document formats (for example `.adoc` or `.rst`) unless conversion is part of the task.

## Principles

1. Structure first, wording second.
2. Keep Markdown lint-clean and deterministic.
3. Use code fences with explicit language tags.
4. Keep file-level conventions consistent across the repository.

## Deterministic Workflow

1. Identify document type (README, guide, API doc, changelog).
2. Apply template and section order from references.
3. Write content with concise headings and actionable examples.
4. Run markdownlint locally and fix violations. Re-run until zero errors are reported. If a violation persists: identify the specific rule, fix the source content or apply a narrow, justified inline exception, then re-lint. Do not proceed until lint is clean.
   - Lint-fix loop: `lint fails → identify rule → fix source or add justified exception → re-lint → proceed only when clean`
5. Validate CI/pre-commit integration for regression prevention.

## Quick Commands

### Lint all Markdown files

```bash
rumdl check .
```

Expected result: no errors for staged or target files. This repository lints with rumdl; for a repository that uses markdownlint, see [Lint: CLI](references/lint-cli.md).

### Lint one skill folder

```bash
rumdl check skills/documentation/markdown-authoring
```

Expected result: folder-specific Markdown issues reported or zero errors.

### Run repository checks

```bash
bunx @biomejs/biome check .
```

Expected result: non-Markdown formatting/lint issues also caught.

### Evaluate this skill quality

```bash
pantheon-skill-auditor evaluate documentation/markdown-authoring --json
```

Expected result: updated dimension scores and grade.

### Read a specific reference

```bash
./scripts/read-reference.sh syntax-headings
```

Expected result: displays reference content for the requested topic.

### Check document style compliance

```bash
bun run check-style "path/to/document.md"
```

Expected result: style validation report printed to stdout.

## Anti-Patterns

### NEVER ship Markdown with missing fence language tags

**WHY:** Untyped code blocks reduce readability and tooling support.

**BAD:** Use plain triple backticks for code samples.
**GOOD:** Use typed fences like ` ```bash ` or ` ```ts `.

**Consequence:** Syntax highlighting and lint checks become inconsistent.

### NEVER ignore markdownlint violations by disabling broad rules

**WHY:** Global suppression hides real quality and maintainability issues.

**BAD:** Turn off multiple rules to make CI green quickly.
**GOOD:** Fix source content or apply narrow, justified exceptions.

**Consequence:** Documentation quality degrades release-over-release.

### NEVER use heading levels out of sequence

**WHY:** Skipped heading levels break document hierarchy.

**BAD:** Jump from `##` to `####` with no `###`.
**GOOD:** Increase heading levels one step at a time.

**Consequence:** Navigation and accessibility suffer.

**Consider** adding a table of contents for documents longer than 300 lines. Optionally include anchor links in headings to improve internal navigation.

### NEVER mix inconsistent list and table styles in one document

**WHY:** Style drift makes docs harder to scan and review.

**BAD:** Alternate list markers and inconsistent table pipe spacing.
**GOOD:** Keep one list style and normalized table formatting.

**Consequence:** Diff noise increases and review confidence drops.

## References

- [Syntax: Headings](references/syntax-headings.md)
- [Syntax: Lists](references/syntax-lists.md)
- [Syntax: Code Blocks](references/syntax-code-blocks.md)
- [Syntax: Links & Images](references/syntax-links-images.md)
- [Syntax: Formatting](references/syntax-formatting.md)
- [Syntax: Other Elements](references/syntax-other-elements.md)
- [Docs: README](references/docs-readme.md)
- [Docs: Organization](references/docs-organization.md)
- [Docs: Writing Style](references/docs-writing-style.md)
- [Docs: API](references/docs-api.md)
- [Docs: Changelog](references/docs-changelog.md)
- [Lint: Config](references/lint-config.md)
- [Lint: Rules](references/lint-rules.md)
- [Lint: CLI](references/lint-cli.md)
- [Lint: CI](references/lint-ci.md)
- [Lint: API](references/lint-api.md)
Pliki w paczce (63)
  • AGENTS.md 3 KB
  • CHANGELOG.md 2 KB
  • SKILL.md 5 KB
  • .audits/latest 1 KB
  • .audits/2026-02-21/analysis.md 8 KB
  • .audits/2026-02-21/audit.json 1 KB
  • .audits/2026-02-21/remediation-plan.md 1 KB
  • .audits/2026-02-22/analysis.md 8 KB
  • .audits/2026-02-22/audit.json 1 KB
  • .audits/2026-02-22/remediation-plan.md 1 KB
  • .audits/2026-02-23/analysis.md 8 KB
  • .audits/2026-02-23/audit.json 1 KB
  • .audits/2026-02-23/remediation-plan.md 1 KB
  • .audits/2026-03-02/analysis.md 1 KB
  • .audits/2026-03-02/audit.json 1 KB
  • .audits/2026-03-02/remediation-plan.md 2 KB
  • .audits/2026-07-01/analysis.md 1 KB
  • .audits/2026-07-01/audit.json 1 KB
  • .audits/2026-07-01/remediation-plan.md 2 KB
  • .audits/2026-10-02/Analysis.md 1 KB
  • .audits/2026-10-02/Remediation.md 1 KB
  • .audits/2026-10-02/audit.json 1 KB
  • .tekhne/plugin.json 1 KB
  • evals/instructions.json 3 KB
  • evals/summary.json 1 KB
  • evals/scenario-1/capability.txt 1 KB
  • evals/scenario-1/criteria.json 1 KB
  • evals/scenario-1/task.md 1 KB
  • evals/scenario-2/capability.txt 1 KB
  • evals/scenario-2/criteria.json 1 KB
  • evals/scenario-2/task.md 1 KB
  • evals/scenario-3/capability.txt 1 KB
  • evals/scenario-3/criteria.json 1 KB
  • evals/scenario-3/task.md 1 KB
  • evals/scenario-4/capability.txt 1 KB
  • evals/scenario-4/criteria.json 1 KB
  • evals/scenario-4/task.md 1 KB
  • evals/scenario-5/capability.txt 1 KB
  • evals/scenario-5/criteria.json 2 KB
  • evals/scenario-5/task.md 1 KB
  • evals/scenario-6/capability.txt 1 KB
  • evals/scenario-6/criteria.json 1 KB
  • evals/scenario-6/task.md 2 KB
  • evals/scenario-7/capability.txt 1 KB
  • evals/scenario-7/criteria.json 2 KB
  • evals/scenario-7/task.md 1 KB
  • references/docs-api.md 8 KB
  • references/docs-changelog.md 2 KB
  • references/docs-organization.md 7 KB
  • references/docs-readme.md 5 KB
  • references/docs-writing-style.md 7 KB
  • references/lint-api.md 10 KB
  • references/lint-ci.md 10 KB
  • references/lint-cli.md 6 KB
  • references/lint-config.md 6 KB
  • references/lint-rules.md 4 KB
  • references/syntax-code-blocks.md 3 KB
  • references/syntax-formatting.md 2 KB
  • references/syntax-headings.md 2 KB
  • references/syntax-links-images.md 3 KB
  • references/syntax-lists.md 3 KB
  • references/syntax-other-elements.md 5 KB
  • scripts/read-reference.sh 1 KB

Wersje

W bazie nie ma innych skilli o nazwie markdown-authoring.

Migawka bazy z 13.11.2026 · wersja paczki 400c40c78ea7 (skrót SHA-256 całej paczki)

Pobrania w ostatnich 30 dniach: 0 · ranking

Zgłoś problem z tym skillem: szkodliwa treść, błędny opis albo prośba autora o usunięcie.

Podobne skille

  • 100markdown
    Formatuje i lintuje Markdown w repozytorium według GitHub Flavored Markdown i konfiguracji markdownlint-cli2: nagłówki, listy, bloki kodu, wyróżnienia, dozwolony HTML i zawijanie wierszy.
  • 100markdown-validation
    Sprawdza składnię, formatowanie i linki w plikach Markdown przez markdownlint-cli2 i markdown-link-check przy commitowaniu dokumentacji oraz w pull requestach.
  • 100markdown-lint
    Konfiguruje markdownlint-cli2 z hookami pre-commit, naprawia hurtowo błędy takie jak MD013, MD040 i MD060 oraz usuwa linie poziome, zachowując frontmatter YAML w monorepo.
  • 100markdown
    Pisze i poprawia pliki Markdown w repozytorium dotfiles zgodnie z konfiguracją markdownlint i ustawieniami zawijania oxfmt, uruchamiając markdownlint-cli2 --fix oraz oxfmt.
  • 100markdown-validation
    Sprawdza składnię, formatowanie i linki w plikach Markdown przez markdownlint-cli2 i markdown-link-check, np. przy commitach.
  • 100markdown-documentation
    Pomaga pisać dokumentację techniczną, pliki README i dokumentację projektu w Markdown, obejmując strukturę, konwencje i dobre praktyki.

Uwagi i zgłoszenia

Wiadomość trafi do Bartosza Sokolińskiego. Adres e-mail jest potrzebny tylko do odpowiedzi. Szczegóły w polityce prywatności.