doc-add-simple-hash

Generate URL-friendly hash anchors for Chinese markdown titles.

3.9k|388|Updated Dec 6, 2018
One-click install
npx skills add https://github.com/didi/mpx --skill doc-add-simple-hash
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-add-simple-hash
Source: https://github.com/didi/mpx/tree/main/.agents/skills/doc-add-simple-hash
Command: npx skills add https://github.com/didi/mpx --skill doc-add-simple-hash

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the process of adding simple, URL-friendly hash anchors to markdown document titles, improving linkability and navigation within documents.

Core Features & Use Cases

  • Automatic Anchor Generation: Scans markdown documents for Chinese titles and generates semantic, simple English hash anchors.
  • Customizable Anchors: Allows for manual specification of anchors using the {#simple-hash} syntax.
  • Use Case: When documenting a complex feature with many Chinese-titled sections, use this Skill to ensure all internal and external links to these sections use clean, stable anchors like #feature-overview instead of #功能概述.

Quick Start

Use the doc-add-simple-hash skill to add simple hash anchors to all Chinese titles in the current markdown document.

Frequently Asked Questions about doc-add-simple-hash

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add URL-friendly hash anchors to Chinese titles in markdown?

To add URL-friendly hash anchors to Chinese titles in markdown, this Skill scans your document and automatically generates semantic English equivalents, ensuring stable and clean anchor links for navigation.

Can I manually define custom anchor links for markdown headings?

Yes, you can manually define custom anchor links for markdown headings by using the `{#simple-hash}` syntax, which overrides automatic generation and ensures specific, stable URL fragments.

What is the best way to generate semantic English anchors for Chinese markdown documents?

The best way to generate semantic English anchors for Chinese markdown documents is using an automated tool that translates titles and enforces uniqueness constraints, providing clean links like `#feature-overview` instead of `#功能概述`.

Why do internal links to Chinese markdown sections break and how to fix them?

Internal links to Chinese markdown sections often break due to non-URL-friendly characters. Fix them by generating simple, semantic English hash anchors that enforce character constraints and ensure link stability.

Does this anchor generation approach enforce uniqueness for markdown headers?

Yes, this anchor generation approach enforces uniqueness for markdown headers by scanning the document and applying constraints to anchor characters, preventing duplicate hash conflicts during navigation.