Skip to content

Latest commit

 

History

History
6 lines (4 loc) · 676 Bytes

File metadata and controls

6 lines (4 loc) · 676 Bytes

A tool to automatically generate the full documentation for the 5hell tool developed for the game known as Grey Hack. The generated documentation contains all possible outputs from 5hell's help command, neatly formatted into a single Markdown file for easier accessibility, readability, and searchability.

Usage guide

To generate the documentation, run the following command in the folder containing this file: npm start

A Markdown file named 5hell-Documentation.md should then be outputted to the same folder, the path to which this file is outputted to can be configured by editing the value of the variable named output_file_path in the src/main.ts file.