skills.rest
Dozyboy
DozyboyCOMMUNITY
Explore all skills by this author →
GitHub

hs:docs-build

Renders Markdown documentation into showcase HTML sites, flat Markdown, PDF, and Excel catalogs.

Updated Jul 19, 2026
Search Tags:#pdf#documentation#markdown#excel#static site generator#bilingual#render pipeline
One-click install
npx skills add https://github.com/Dozyboy/VSF --skill hs-docs-build-dozyboy
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: hs:docs-build
Source: https://github.com/Dozyboy/VSF/tree/main/Day2_VSF/Demo1/harness/plugins/hs/disabled-skills/docs-build
Command: npx skills add https://github.com/Dozyboy/VSF --skill hs-docs-build-dozyboy

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires markdown, xhtml2pdf, openpyxl, pyyaml, puppeteer-core, and includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve? Teams maintaining bilingual (VI/EN) architecture documentation in Markdown need a repeatable way to publish it as an interactive showcase website and distributable release artifacts without hand-editing HTML or duplicating content across formats. ## Core Features & Use Cases - Showcase HTML rendering: Converts docs/**/*.md plus _index/bands.yaml taxonomy and _present/* presentation config into a themed static site in public/ with language toggle, sidebar navigation, and interactive effects. - Release artifact generation: Produces dist/ outputs — a merged flat Markdown file, a PDF via xhtml2pdf, and an Excel catalog (modules, parts, links, foundations, safety sheets) via openpyxl. - Verification gates: Ships static and headless-browser E2E checks plus a self-check script that assert links resolve, images load, and generated data-JS is bundled. - Use Case: After hs:docs-standardize passes, run the build to regenerate the full showcase site and all distribution files from the physical Markdown sources in one orchestrated pipeline. ## Quick Start Ask the assistant to run the docs build to render the docs folder into the public showcase site and the dist release artifacts.

Frequently Asked Questions about hs:docs-build

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

FAQPage Schema
How do I build a static documentation site from Markdown files?▼

Run the build pipeline after the standardize gate passes: it loads the docs model, generates showcase data-JS from the _index taxonomy, renders md pages to HTML partials, and assembles the themed site into public/ via the ssg engine.

How to convert Markdown documentation to PDF in Python?▼

The build_flat_md script merges all docs into one Markdown file in section order, then build_pdf converts it to HTML with the markdown library and renders PDF via xhtml2pdf, with a link callback resolving relative image paths.

Does the build modify my Markdown source files?▼

No. The build is render-only: it never creates or edits design content and never changes _index YAML files. Content lives in the physical md files; the pipeline only renders what already exists.

Why does the docs build fail before rendering?▼

The build aborts when structural validation reports errors, since hs:docs-standardize must pass with zero errors first. It prints each error with code and location, then exits non-zero instead of producing broken output.

What Python libraries are required for the docs build pipeline?▼

The pipeline uses pyyaml for frontmatter and _index parsing, markdown for md-to-HTML conversion, xhtml2pdf for PDF generation, and openpyxl for the Excel catalog. Missing optional libraries degrade gracefully with warnings instead of crashing.

Related Skills

Explore More Software Engineering Skills→
edgeandnodeedgeandnode

code-pattern-discovery

Discover and load coding pattern documentation from YAML frontmatter metadata.

Official
Intermediate
vmasranivmasrani
2

deploy

Deploy projects to Cloudflare Pages with Basic Auth protection.

Community
Intermediate
ClyptAIClyptAI

browse

Automate QA testing with a Playwright-based headless browser.

Official
Advanced
kettleofketchupkettleofketchup

zensical

Migrate mkdocs-material projects to Zensical and manage their documentation.

Community
Intermediate