Metadata-Version: 2.5
Name: eq_markdown
Version: 0.1.0
Summary: Python-Markdown extensions for the RedGuides and MacroQuest documentation sites
Project-URL: Repository, https://github.com/RedGuides/eq_markdown
Project-URL: Issues, https://github.com/RedGuides/eq_markdown/issues
Author-email: Redbot <ask@redguides.com>
License-Expression: GPL-3.0-or-later
License-File: LICENSE.txt
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Text Processing :: Markup
Classifier: Topic :: Text Processing :: Markup :: Markdown
Requires-Dist: markdown>=3.6
Requires-Dist: pymdown-extensions>=10.0
Description-Content-Type: text/markdown

# eq_markdown

Python-Markdown extensions for RG/MQ Docs. 

## Install

```
pip install -e path/to/eq_markdown
```

`mkdocs.yml`:

```yaml
markdown_extensions:
  - eq_markdown.member
```

## `member` block

Documents one datatype member or TLO form.

```markdown
/// member | int HPDrain[string]
    label: HPDrain
Description, in Markdown.
///
```

- **type member** - After the `|`. A single word is a member with no type.
- **label** - (optional) TOC text and anchor. Defaults to the member.
- **attrs** - (optional) Attributes for the heading. See the
  [pymdownx.blocks docs](https://facelessuser.github.io/pymdown-extensions/extensions/blocks/).

Heading level is set automatically (one below the section above it). To fix it, use
`- eq_markdown.member: {level: 3}`.
