mirror of https://github.com/hugo-fixit/FixIt.git synced 2026-08-24 15:28:57 +00:00

Files

T

Cell 2c0b48370b feat(gen-docs): add Hugo partials docs generation (#809 )

* feat(gen-docs): add documentation generation package with SassDoc and TypeDoc support

Add new `@hugo-fixit/gen-docs` package that parses Hugo config (hugo.toml) and generates
documentation. Includes SassDoc annotations for SCSS variables and mixins, TypeDoc config
for TypeScript source docs, and a `.sassdocrc` configuration file.

* docs(readme): add browsers support section

* feat(gen-docs): add Hugo partials docs generation and fix config empty sections

- Add partial-parser.ts: parses Hugo partial comment blocks (@param/@return/@example)
- Add partials.ts renderer: generates grouped Markdown with param tables
- Add `partials` subcommand with -t/-o options for template injection
- Fix config-parser: empty TOML sections (library.js/library.css) now retain descriptions
- Fix config-parser: correctly distinguish section-level vs key-level comments
- Update README with partials subcommand documentation

2026-07-21 12:19:07 +08:00

src

feat(gen-docs): add Hugo partials docs generation (#809 )

2026-07-21 12:19:07 +08:00

package.json

feat(gen-docs): add Hugo partials docs generation (#809 )

2026-07-21 12:19:07 +08:00

README.md

feat(gen-docs): add Hugo partials docs generation (#809 )

2026-07-21 12:19:07 +08:00

tsconfig.json

feat(gen-docs): add Hugo partials docs generation (#809 )

2026-07-21 12:19:07 +08:00

README.md

@hugo-fixit/gen-docs

Generate API reference documentation for the FixIt Hugo theme from source code.

Config: parses hugo.toml to produce Markdown configuration reference.
Partials: parses layouts/_partials/ to produce Markdown Hugo partials reference.

Usage

# Generate all docs (config + partials)
pnpm gen:docs

# Config subcommand
pnpm gen:docs config
pnpm gen:docs config hugo.toml -o /path/to/config.md
pnpm gen:docs config latest
pnpm gen:docs config https://example.com/hugo.toml
pnpm gen:docs config hugo.toml -t template.md

# Partials subcommand
pnpm gen:docs partials
pnpm gen:docs partials -t template.md
pnpm gen:docs partials -o output.md

Subcommands

`config`

Generates configuration reference from hugo.toml. The input source can be:

Local file (default): pnpm gen:docs config [path]
URL: pnpm gen:docs config https://example.com/hugo.toml
Latest release: pnpm gen:docs config latest (fetches from GitHub releases)

Options:

-o, --output <file> — Write output to file (default: stdout)
-t, --template <file> — Inject docs between  and  markers in the template file

`partials`

Generates Hugo partials reference from layouts/_partials/.

Options:

-o, --output <file> — Write output to file (default: stdout)
-t, --template <file> — Inject docs between  and  markers in the template file

Default Output

When run without a subcommand, generates both config and partials docs (injects into en docs templates).

Architecture

src/
  index.ts                  # CLI entry point (commander)
  parsers/
    config-parser.ts        # TOML parser for hugo.toml
    partial-parser.ts       # HTML comment parser for layouts/_partials/
  renderers/
    config.ts               # -> config.md
    partials.ts             # -> partials.md