Skip to content

fsegurai/manifest-generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Manifest Generator Logo

Build Main Status Latest Release
GitHub contributors Dependency status for repo GitHub License
Stars Forks

@fsegurai/manifest-generator

Monorepo for the Manifest Generator ecosystem.

This repository contains:

  • the published package (@fsegurai/manifest-generator)
  • versioned product documentation (docs/*)
  • a demo app that consumes generated artifacts

What the package does

The package scans Markdown and MDX documentation and generates:

  • manifest.json (hierarchical navigation with sorting)
  • search-index.json (flat search entries with keywords)

It can be used via CLI or programmatic API. Supports 20+ frontmatter fields, frontmatter validation, recursive project discovery, file watching, and sorting.

Repository structure

manifest-generator/
├── docs/
│   └── 1.0.0-beta.2/
│       └── content/
├── packages/
│   └── manifest-generator/
│       ├── src/
│       │   ├── cli.ts
│       │   ├── index.ts
│       │   └── types.ts
│       └── spec/
├── demo/
└── scripts/

Run locally (contributors)

Requirements

  • Node.js 22+
  • Bun 1.3+

Setup

bun install

Development workflow

# run tests
bun test

# build all workspaces and demo
bun run build

# build only the package
bun run --filter '@fsegurai/manifest-generator' pkg:build

# run package tests only
bun run --filter '@fsegurai/manifest-generator' pkg:test

Run the CLI locally

bun ./packages/manifest-generator/src/cli.ts --help
bun ./packages/manifest-generator/src/cli.ts --discover --docs-root ./docs

Regenerate versioned docs artifacts

bun ./packages/manifest-generator/src/cli.ts \
  --docs-root ./docs/1.0.0-beta.2 \
  --output ./docs/1.0.0-beta.2

Use as an external user

If you only want to consume the package, start with the versioned docs:

  • docs/1.0.0-beta.2/content/README.md

Or run directly from npm:

npx @fsegurai/manifest-generator --help
npx @fsegurai/manifest-generator --route ./docs

License

MIT

About

Manifest Generator is a tool to generate manifest files and search indexes based on a given documentation structure.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors