pub struct MarkdownGenerator { /* private fields */ }Expand description
Drives the markdown generation run by walking tracked files, cleaning artifacts, and aggregating text.
Implementations§
Source§impl MarkdownGenerator
impl MarkdownGenerator
Sourcepub fn new(options: MarkdownGeneratorOptions) -> Self
pub fn new(options: MarkdownGeneratorOptions) -> Self
Creates a generator for library/programmatic use.
This mode avoids project-management side effects: it does not create a
todo file and does not modify .gitignore.
Sourcepub fn new_for_cli(
options: MarkdownGeneratorOptions,
generate_embeddings: bool,
) -> Self
pub fn new_for_cli( options: MarkdownGeneratorOptions, generate_embeddings: bool, ) -> Self
Creates a generator configured for the CLI.
CLI mode preserves Node CLI parity by including/creating todo and
updating .gitignore. Embeddings artifacts are only managed when
generate_embeddings is true.
Sourcepub async fn create_markdown_document(&mut self) -> Result<MarkdownResult>
pub async fn create_markdown_document(&mut self) -> Result<MarkdownResult>
Creates the complete markdown document that combines code snippets with todo notes.
Auto Trait Implementations§
impl Freeze for MarkdownGenerator
impl RefUnwindSafe for MarkdownGenerator
impl Send for MarkdownGenerator
impl Sync for MarkdownGenerator
impl Unpin for MarkdownGenerator
impl UnsafeUnpin for MarkdownGenerator
impl UnwindSafe for MarkdownGenerator
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more