Documentation

PTKRDME Ecosystem

PTKRDME is a suite of tools for generating professional README documentation. All three tools share a common library for section definitions, auto-detection logic, configuration management, and markdown rendering. All managers live in ptkrdmelib — the canonical single source of truth.

All three tools consume the same ptkrdmelib library. The CLI and VS Code extension use the full manager classes; the web app uses only section data and types with its own React render layer.

Loading diagram...

CLI Tool

Terminal-based README generator with automatic project detection, dependency scanning, and CI integration.

  • Installation
  • Quick Start
  • Commands
  • Auto-Detection
Read more

Web App

Browser-based README configurator with drag-and-drop sections, live preview, and project management.

  • Getting Started
  • Configurator
  • Saving Projects
  • Under the Hood
Read more

VS Code Extension

Editor-integrated README management with sidebar sections, workspace-aware config, and one-click generation.

  • Installation
  • Sidebar
  • Features
  • Message Protocol
Read more

Section Types

Reference for all built-in section types shared across every tool. Fields, autodetection, and render output.

  • Installation
  • License
  • Brands
  • Shields
  • Related Projects
Read more

Developer Guide

Architecture overview, data flow, and complete guide to adding custom sections with autodetection.

  • Custom Sections
  • Registration Checklist
Read more