consolelog.tools

Documentation Site Generator

Generate a complete documentation site structure with categories, pages, and a config file — ready for VitePress, Docusaurus, or any Markdown-based docs framework

About this ToolHow it works, benefits & use cases

Lay out a whole documentation site before you wire up a framework. You define a site name and description, organize content into ordered categories (each with a name and slug), and add pages that belong to a category — title, slug, ordering, and Markdown body. From that, the generator produces a complete file set: a docs/README.md home page that links every category and its pages, a navigation.md, a machine-readable config.json describing the nav tree, a Markdown file per page under docs/<category>/<slug>.md, and a per-category index README. It also draws an ASCII directory tree so you can see the structure at a glance. A built-in file browser lets you click through each generated file and copy or download its contents. The output is plain Markdown and JSON, so it drops cleanly into VitePress, Docusaurus, or any Markdown-based docs setup. Pages sort by their order field, and configuration persists locally between sessions.

How to Use

  1. 1Enter a Site name (required) and an optional Description, or click Load template for a starter site.
  2. 2Add categories with the Add category button, setting each name, slug, and display order.
  3. 3Add pages with Add page, choosing a category, slug, order, and writing the Markdown content.
  4. 4Click Generate docs site to build the file tree, config, and per-page Markdown files.
  5. 5Review the ASCII Directory structure, then open any file in the Generated files browser.
  6. 6Copy or download individual files, or pipe a file’s content to another tool.

Key Benefits

  • Generates a full docs/ tree: home page, navigation, config.json, and one file per page
  • Categories and pages are ordered by an explicit order field
  • Per-category index README files with page previews
  • ASCII directory tree shows the structure before you scaffold it
  • Built-in file browser to inspect, copy, or download each generated file
  • Output is plain Markdown + JSON — drops into VitePress, Docusaurus, and similar
  • Site configuration persists locally so you can resume editing

Common Use Cases

  • Scaffolding the folder and page structure for a new documentation site
  • Planning an information architecture (categories and pages) before writing content
  • Generating a config.json navigation tree to feed a custom docs renderer
  • Producing category index pages that summarize the pages beneath them
  • Handing a team a ready-to-fill Markdown skeleton for project docs

Site info

Categories

Pages

File tree that will be created

Run to see the generated directory structure.

Was this tool helpful?

Share Your Experience

Help others discover this tool!

Related tools