Struct HelpFile 

pub struct HelpFile { /* private fields */ }

HelpFile - Manages markdown help files

Modern alternative to Borland’s THelpFile

Implementations

impl HelpFile

pub fn new(path: impl AsRef<Path>) -> Result<Self>

Create a new help file from a markdown file

pub fn from_content(content: &str) -> Self

Create a help file from an in-memory markdown string

pub fn get_topic(&self, id: &str) -> Option<&HelpTopic>

Get a topic by ID

pub fn get_default_topic(&self) -> Option<&HelpTopic>

Get the default topic

pub fn get_topic_ids(&self) -> Vec<String>

Get all topic IDs

pub fn has_topic(&self, id: &str) -> bool

Check if a topic exists

pub fn path(&self) -> &str

Get the file path

pub fn reload(&mut self) -> Result<()>

Reload the help file from disk