summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorA Farzat <a@farzat.xyz>2026-06-20 04:33:13 +0300
committerA Farzat <a@farzat.xyz>2026-06-20 10:49:38 +0300
commit3bf55f98e743d4513f25f927a55f47b15561ad9e (patch)
treee14d01332c4278b3c0cbd2bb5f4e220bca494ac8 /src
parentf7bc0deb95371c4f6a196154e2e3a5e3189c172e (diff)
downloadrepo2markdown-3bf55f98e743d4513f25f927a55f47b15561ad9e.tar.gz
repo2markdown-3bf55f98e743d4513f25f927a55f47b15561ad9e.zip
Add module docs for lib.rs
Diffstat (limited to 'src')
-rw-r--r--src/lib.rs9
1 files changed, 9 insertions, 0 deletions
diff --git a/src/lib.rs b/src/lib.rs
index b6ed259..c35c0ea 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,3 +1,12 @@
+//! Convert repository file lists into Markdown.
+//!
+//! `repo2markdown` reads null-separated path lists, normalizes paths, and renders selected files
+//! into Markdown. It also exposes small utilities for wrapping Markdown in fences and editing
+//! null-separated path lists.
+//!
+//! The crate is used by the main `repo2markdown` binary and by helper binaries such as
+//! `r2md-fence`, `r2md-append`, `r2md-prepend`, and `r2md-remove`.
+
pub mod fence_wrapper;
pub mod fenced_md_generator;
pub mod logger;