Skip to content
Skillpedia
Documentation101k · #413

docs-page

Generates a documentation page with navigation and a table of contents. Perfect for tutorials, guides, and API references.

What it does

This tool creates a complete documentation page in a single HTML file. It organizes content into three columns: a navigation menu on the left, the main body of text in the center, and a table of contents on the right.

When to use it

  • ✓When you need a guide or tutorial page.
  • ✓When generating an API reference.
  • ✓To create detailed technical documentation.

Example of what to ask your AI

“Create a documentation page for the user login function, including code examples and warning notes.”

Want more? Open the sections below.

How to use

The easiest way: copy the message below and paste it into Claude, ChatGPT, Cursor or any AI. It reads the skill and follows the instructions.

Skill link

https://github.com/nexu-io/open-design/blob/main/design-templates/docs-page/SKILL.md

Ready-to-paste message

Use this skill to help me: https://github.com/nexu-io/open-design/blob/main/design-templates/docs-page/SKILL.md Read the SKILL.md file at that link and follow its instructions for my task.
How it works

The tool reads design instructions, picks a relevant topic, and arranges content into three columns using CSS Grid. It ensures text is readable and code is formatted correctly.

Installation

Easiest way: copy the skill link and paste it into Claude, ChatGPT or Cursor asking it to follow the instructions.

In the terminal (Claude Code, Codex, Cursor), in your project folder:

npx skills add nexu-io/open-design --skill docs-page

Or download just the file:

curl -L https://raw.githubusercontent.com/nexu-io/open-design/main/design-templates/docs-page/SKILL.md -o SKILL.md
Technical content (original SKILL.md)

Original text by the author, straight from GitHub.

Docs Page Skill

Produce a single, three-column documentation page in one HTML file.

Workflow

  1. Read the active DESIGN.md (injected above). Use the body type token for prose; the mono token for code; respect line-height and max-width rules.
  2. Pick a topic from the brief — the page should look like real docs, not a generic wireframe. Concrete API names, command examples, plausible parameters.
  3. Lay out three regions, expressed on the inline axis so the layout flips correctly under dir="rtl":
    • Inline-start nav (240–280px, sticky): grouped link list, current page bolded with an inline-start-edge accent stripe. 3–5 groups of 4–8 links.
    • Article body (max-width ~720px, centered in the middle column): H1, lede paragraph, H2 sections, code blocks, callout boxes (note / warning), inline links, lists.
    • Inline-end TOC (200–240px, sticky): "On this page" with the H2/H3 anchors, current section highlighted as the user scrolls.
  4. Write a single HTML document:
    • <!doctype html> through </html>, all CSS inline.
    • CSS Grid for the three columns; sticky positioning for the rails.
    • Code blocks: monospace token, soft surface fill, copy-button affordance (visual only — no JS needed).
    • Anchor IDs on every H2/H3 so the TOC links work.
    • data-od-id on the nav, article, and TOC.
  5. Prose: write at least 350 words of believable docs. Include at least one shell command, one code snippet (5–15 lines), one callout, one table.
  6. Self-check:
    • Body text wraps at the DS line-length sweet spot (60–75 chars).
    • Code uses the DS mono token, not generic monospace.
    • Accent is restrained — used for active nav item, links, one callout border. Not on body text.
    • Page is readable at 1280w and collapses gracefully below 900w (TOC drops out, nav becomes a top drawer).
    • Use logical CSS (margin-inline-start, border-inline-start, inset-inline-end, text-align: start) on the rails and accent stripe so the layout flips correctly under dir="rtl".

Output contract

Emit between <artifact> tags:

<artifact identifier="docs-slug" type="text/html" title="Docs — Page Title">
<!doctype html>
<html>...</html>
</artifact>

One sentence before the artifact, nothing after.

FAQ

What are 'tokens'?

Tokens are like pre-defined building blocks that the tool uses to format text and code, ensuring consistency.

What does 'layout flips correctly under dir="rtl"' mean?

This means the page automatically adapts for languages read from right to left (like Arabic), by flipping the column order.

Does the generated page require JavaScript?

No, the code copy button is visual only. The main page structure is built with HTML and CSS.

Details

Original description by the author

A documentation page — inline-start nav, scrollable article body, inline-end table of contents. Use when the brief mentions "docs", "documentation", "guide", "API reference", or "tutorial".

repo: nexu-io/open-design

Popularity

GitHub stars
101k
Ranking position
#413
License
Apache-2.0
Updated
10/16/2026

Is this skill useful?

0

Sign in to vote.

Comments

  • …

More skills from this repository

Similar skills