Generate Sitemap
Designgenerate-sitemapGenerate Sitemap is an Agent Skill for design published in the dandye/ai-runbooks repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
Generate hierarchical site structure and navigation maps. Creates visual representations of information architecture and content relationships.
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Inspect the Agent Skill at https://github.com/dandye/ai-runbooks/blob/HEAD/skills/generate-sitemap/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/generate-sitemap, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
Generate Sitemap Skill
Generate a hierarchical representation of the site structure and navigation maps. This skill visualizes the information architecture to support user experience design and content organization.
Inputs
PATH- The root directory of the project or site (e.g., "/project")HIERARCHICAL- (Optional) Boolean, whether to strictly follow directory hierarchy (default: true)CROSS_REFERENCES- (Optional) Boolean, whether to include cross-links between pages (default: false)EXPORT_FORMAT- (Optional) Output format: "markdown", "xml", "svg", "mermaid" (default: "mermaid")
Workflow
Step 1: Structure Traversal
Traverse the PATH to understand the directory and file structure.
- Build a tree representation of folders and files.
- Identify "index" or "home" pages for each section.
Step 2: Relationship Mapping
If CROSS_REFERENCES is true, analyze links within content to identify non-hierarchical connections.
- Map internal links between nodes.
- Identify "See Also" or related content sections.
Step 3: Visualization Generation
Convert the structural tree into the requested EXPORT_FORMAT.
For Mermaid (Diagram):
- Generate a graph TD or Mindmap definition.
- Nodes represent pages/sections.
- Edges represent hierarchy (parent-child) or links.
For XML (Standard Sitemap):
- Generate compliant sitemap.xml format.
Step 4: Output Rendering
Return the generated sitemap code or file.
Required Outputs
A SITEMAP_OUTPUT string containing the sitemap representation in the specified OUTPUT_FORMAT.
Example (Mermaid):
graph TD
Root[Home] --> Docs[Documentation]
Root --> Blog[Blog]
Docs --> API[API Reference]
Docs --> Guides[User Guides]
API --> Auth[Authentication]
Quick Reference
- Purpose: Visualize and plan information architecture and navigation.
- Tools: Compatible with Mermaid.js for visualization.