# describe_markdown
URL: https://lsd.tools/docs/api-describe-describe-markdown
Updated: 2026-07-17

## Parameters

| name | type | default | description |
|---|---|---|---|
| `data` | `Optional[Dict[str, Any]]` | `None` | a snapshot from [`describe_api()`](/docs/api-describe-describe-api); recomputed fresh when omitted |

## Example

```python
from lsdtools.advanced import describe_markdown

open("LSD_CONTEXT.md", "w").write(describe_markdown())
```

This is exactly what [`lsd api context`](/docs/api-cli) prints:

```bash
lsd api context > LSD_CONTEXT.md
```

## Notes

Lives in [`lsdtools.advanced`](/docs/api-advanced). Takes the same optional `data` snapshot
(recomputed when omitted). The rendered Markdown includes the one import rule, how to write a step,
the full public API name list, and every available step and entity with its signature and docstring
— sized to hand to an AI assistant as project context so it generates code against the current
surface.

## See also

**API:** [describe_api](/docs/api-describe-describe-api) · [describe_text](/docs/api-describe-describe-text) · [lsdtools.advanced](/docs/api-advanced)

**Guides:** [CLI commands](/docs/api-cli)