11<!-- code2docs:start --> # typermd
22
3- ![ version] ( https://img.shields.io/badge/version-0.1.0-blue ) ![ python] ( https://img.shields.io/badge/python-%3E%3D3.10-blue ) ![ coverage] ( https://img.shields.io/badge/coverage-unknown-lightgrey ) ![ functions] ( https://img.shields.io/badge/functions-61 -green )
4- > ** 61 ** functions | ** 5** classes | ** 10 ** files | CC̄ = 2.8
3+ ![ version] ( https://img.shields.io/badge/version-0.1.0-blue ) ![ python] ( https://img.shields.io/badge/python-%3E%3D3.10-blue ) ![ coverage] ( https://img.shields.io/badge/coverage-unknown-lightgrey ) ![ functions] ( https://img.shields.io/badge/functions-66 -green )
4+ > ** 66 ** functions | ** 5** classes | ** 13 ** files | CC̄ = 2.7
55
66> Auto-generated project documentation from source code analysis.
77
@@ -146,30 +146,39 @@ Content outside the markers is preserved when regenerating. Enable this with `sy
146146
147147```
148148typermd/
149- ├── tables_panels ├── table_styles_demo ├── typermd/ ├── basic ├── logger_usage ├── logger├── project ├── themes ├── renderer ├── help```
149+ ├── logger_usage ├── basic ├── ansi ├── typermd/ ├── table_styles_demo ├── tables ├── renderer ├── tables_panels ├── logger├── project ├── themes ├── highlighting ├── help```
150150
151151## API Overview
152152
153153### Classes
154154
155+ - **`MarkdownRenderer`** — Renders markdown text to the terminal with ANSI colors.
155156- **`Logger`** — Markdown-aware structured logger.
156157- **`Theme`** — Color theme definition with named color slots.
157- - **`MarkdownRenderer `** — Renders markdown text to the terminal with ANSI colors .
158+ - **`HighlightRule `** — Highlighter rule: pattern + color .
158159- **`MarkdownHelpFormatter`** — Click HelpFormatter that renders markdown in help text.
159160
160161### Functions
161162
162- - `deps()` — Show project dependencies as a table.
163- - `info()` — Show app info in a panel.
164- - `demo()` — Demonstrate all table styles.
165- - `echo(message, file, nl, err)` — Enhanced echo that auto-detects and renders markdown.
166- - `table(headers, rows, style)` — Render a table to the terminal.
167- - `panel(content, title, style_color)` — Render a bordered panel.
168- - `blockquote(content)` — Render a blockquote.
163+ - `deploy(env, dry_run)` — Simulate a deployment with structured logging.
169164- `hello(name, formal)` — Say hello with markdown formatting.
170165- `status()` — Show system status with styled output.
171166- `demo()` — Demonstrate all markdown features.
172- - `deploy(env, dry_run)` — Simulate a deployment with structured logging.
167+ - `strip_ansi(text)` — Remove all ANSI escape codes from text.
168+ - `is_no_color()` — Check if NO_COLOR env is set (https://no-color.org).
169+ - `supports_color(stream)` — Detect if the output stream supports color.
170+ - `echo(message, file, nl, err)` — Enhanced echo that auto-detects and renders markdown.
171+ - `panel(content, title, style_color)` — Render a bordered panel.
172+ - `blockquote(content)` — Render a blockquote.
173+ - `demo()` — Demonstrate all table styles.
174+ - `table(headers, rows, style)` — Render a table to the terminal.
175+ - `looks_like_markdown(text)` — Heuristic: does the text contain markdown formatting?
176+ - `get_renderer(stream, use_colors)` — Get or create the default MarkdownRenderer.
177+ - `render_markdown(text, stream, use_colors)` — Render markdown text to a stream.
178+ - `md(text)` — Render markdown text to stdout. Primary convenience function.
179+ - `render_to_string(text)` — Render markdown and return as string.
180+ - `deps()` — Show project dependencies as a table.
181+ - `info()` — Show app info in a panel.
173182- `get_logger(name, verbose)` — Get or create the default logger.
174183- `set_logger(logger)` — Replace the default logger.
175184- `get_theme()` — Get the current active theme.
@@ -178,12 +187,7 @@ typermd/
178187- `list_themes()` — Return list of available theme names.
179188- `is_no_color()` — Check if NO_COLOR env is set.
180189- `init_theme_from_env()` — Initialize theme from TYPERMD_THEME env variable.
181- - `strip_ansi(text)` — Remove all ANSI escape codes from text.
182- - `looks_like_markdown(text)` — Heuristic: does the text contain markdown formatting?
183- - `get_renderer(stream, use_colors)` — Get or create the default MarkdownRenderer.
184- - `render_markdown(text, stream, use_colors)` — Render markdown text to a stream.
185- - `md(text)` — Render markdown text to stdout. Primary convenience function.
186- - `render_to_string(text)` — Render markdown and return as string.
190+ - `highlight_code(code, lang)` — Apply syntax highlighting to a code block.
187191- `install_help_formatter(app)` — Install the markdown help formatter on a Typer app.
188192
189193
@@ -194,10 +198,13 @@ typermd/
194198📄 `examples.table_styles_demo` (1 functions)
195199📄 `examples.tables_panels` (2 functions)
196200📄 `project`
197- 📦 `src.typermd` (5 functions)
201+ 📦 `src.typermd` (3 functions)
202+ 📄 `src.typermd.ansi` (3 functions)
198203📄 `src.typermd.help` (6 functions, 1 classes)
204+ 📄 `src.typermd.highlighting` (2 functions, 1 classes)
199205📄 `src.typermd.logger` (12 functions, 1 classes)
200- 📄 `src.typermd.renderer` (24 functions, 2 classes)
206+ 📄 `src.typermd.renderer` (19 functions, 1 classes)
207+ 📄 `src.typermd.tables` (7 functions)
201208📄 `src.typermd.themes` (7 functions, 1 classes)
202209
203210## Requirements
@@ -208,8 +215,8 @@ typermd/
208215## Contributing
209216
210217**Contributors:**
211- - Tom Sapletta <tom-sapletta-com@users.noreply.github.com>
212218- Tom Softreck <tom@sapletta.com>
219+ - Tom Sapletta <tom-sapletta-com@users.noreply.github.com>
213220
214221We welcome contributions! Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines.
215222
0 commit comments