Skip to main content

Module docs

Module docs 

Source
Expand description

Documentation Generation for pages export.

Automatically generates comprehensive, deployment-specific documentation that is included with each published site.

§Overview

Generated documentation includes:

  • README.md: Main archive description for repository root
  • SECURITY.md: Detailed security model and threat analysis
  • help.html: In-app help accessible from web viewer
  • recovery.html: Password recovery instructions
  • about.txt: Simple text explanation for non-technical users

Structs§

DocConfig
Configuration for documentation generation.
DocumentationGenerator
Generator for export documentation.
GeneratedDoc
A generated documentation file.

Enums§

DocLocation
Location where a generated document should be placed.