Function lib::example[][src]

pub fn example<'a>(
    path: Option<&'a str>
) -> Result<Option<&'a str>, SmoothError<'a>>

Provides a example markdown document showcasing the key concepts of rsmooth. If no path is given, the method will return the document as a string otherwise the content will be saved to the given path.