Skip to content

luke-pekala/doc-struct

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

DocStruct

A browser-based documentation template generator. Select a template type, fill in the fields, and get a perfectly structured Markdown file — instantly.

Live App

docstruct.vercel.app

What It Does

DocStruct generates structured Markdown templates for five documentation types:

  • API Reference
  • User Manual
  • Release Notes
  • How-To Guide
  • Troubleshooting Guide

Select a type, fill in the metadata fields, and the template updates live. Copy to clipboard or download as a .md file.

Stack

  • HTML · CSS · Vanilla JavaScript
  • No frameworks, no build step, no dependencies
  • Deploys as a static site on Vercel

Features

  • Dynamic form rendering — fields change based on selected template type
  • Live Markdown preview updates on every keystroke
  • Copy to clipboard and download as .md
  • Word count, line count, and section count stats
  • Dark / light theme toggle
  • Matches the StyleGuard design system

Part of a 26-App Portfolio

DocStruct is App C of 26 in a Phase 1 portfolio of browser-based documentation tools built with vanilla HTML, CSS, and JavaScript.

App Name Description
A StyleGuard Documentation style checker
B GlossaryKit Technical glossary manager
C DocStruct Documentation template generator

Local Development

No build step needed. Clone the repo and open index.html in a browser, or use Live Server in VS Code.

git clone https://github.com/your-username/doc-struct.git
cd doc-struct
# open index.html or use Live Server

License

MIT

About

A browser-based documentation template generator. No login, no install.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors