Documentation
¶
Overview ¶
Package internal provides utility functions for walking and processing node structures.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type MDNode ¶
type MDNode struct {
// Level indicates the heading level (1-6) for this node in the Markdown hierarchy
Level int
// Title contains the formatted header text for this node (e.g., "# Section Name")
Title string
// Body contains the content text for this node, typically key-value pairs or descriptive text
Body string
// Children contains nested MDNode elements that represent subsections or related content
Children []MDNode
}
MDNode represents a Markdown node structure used to build hierarchical document representations. It converts structured data into a Markdown-like format with headers and content.
func Walk ¶
func Walk(opnsense model.OpnSenseDocument) MDNode
Walk converts an OpnSenseDocument into a hierarchical MDNode tree representing its structure as Markdown-like headers and content.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package audit provides security audit functionality for OPNsense configurations against industry-standard compliance frameworks through a plugin-based architecture.
|
Package audit provides security audit functionality for OPNsense configurations against industry-standard compliance frameworks through a plugin-based architecture. |
|
Package config provides application configuration management.
|
Package config provides application configuration management. |
|
Package constants defines shared constants used across the application.
|
Package constants defines shared constants used across the application. |
|
Package converter provides functionality to convert OPNsense configurations to various formats.
|
Package converter provides functionality to convert OPNsense configurations to various formats. |
|
Package display provides functions for styled terminal output.
|
Package display provides functions for styled terminal output. |
|
Package export provides functionality to export data to files.
|
Package export provides functionality to export data to files. |
|
Package log provides centralized logging functionality for the opnDossier application.
|
Package log provides centralized logging functionality for the opnDossier application. |
|
Package markdown provides advanced formatting and content enrichment for markdown generation.
|
Package markdown provides advanced formatting and content enrichment for markdown generation. |
|
Package model defines the data structures for OPNsense configurations.
|
Package model defines the data structures for OPNsense configurations. |
|
Package parser provides error types and utilities for parsing OPNsense configuration files.
|
Package parser provides error types and utilities for parsing OPNsense configuration files. |
|
Package plugin provides error definitions and interfaces for compliance plugins.
|
Package plugin provides error definitions and interfaces for compliance plugins. |
|
plugins
|
|
|
firewall
Package firewall provides a compliance plugin for firewall-specific security checks.
|
Package firewall provides a compliance plugin for firewall-specific security checks. |
|
sans
Package sans provides a compliance plugin for SANS security controls.
|
Package sans provides a compliance plugin for SANS security controls. |
|
stig
Package stig provides a compliance plugin for STIG security controls.
|
Package stig provides a compliance plugin for STIG security controls. |
|
Package processor provides interfaces and types for processing OPNsense configurations.
|
Package processor provides interfaces and types for processing OPNsense configurations. |
|
Package validator provides demo validation functionality for OPNsense configurations.
|
Package validator provides demo validation functionality for OPNsense configurations. |
Click to show internal directories.
Click to hide internal directories.