Papyrus Markdown Docs Generator
This page is a utility for generating bare-bones Markdown documentation for Papyrus scripts.
It can either process a single file and output the Markdown below—or it can process an entire directory recursively, outputting the Markdown as files by the same name, but with the md extension appended.
This page was build with generating documentation for Modding.wiki in mind.
IMPORTANT:
This tool is currently only intended for use with Skyrim Papyrus scripts. Fallout 4 Papyrus support may come at a later date.
WARNING:
DO NOT simply copy-paste to the wiki! To provide coherent documentation, you should review each element with care. No generator is perfect, and programmers infamously do not document their code. The documentation extracted here may be lacking or even non-existent.
Select an entire directory for batch processing. .psc files will be parsed and the documentation will be outputted as .psc.md files alongside the original files. WILL overwrite existing files.
Select a single file for processing. The documentation will be outputted in the below text area.
The name of the library. For instance, Vanilla.
Modding.wiki-relative URL to the library's folder page.
Case-insensitive scheme to look for when trying to detect Event Registration functions. %e% is substituted for the event's name (with some words, common prefixes, and common suffixes removed).
The default (RegisterFor%e%) will serve just fine for vanilla.
# Markdown Output
Here, you'll find the `Markdown` that you generate from ***single*** files (or the *last* file in the selected folder) above.
* Thanks to [highlight_js](https://highlightjs.org/), we have fancy highlighting here!