Metadata-Version: 2.3
Name: md_head_num
Version: 0.1.1
Summary: get the numbering at markdown file
License: MIT
Author: kh.cha
Author-email: star2kis@nate.com
Requires-Python: >=3.9
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Description-Content-Type: text/markdown


## Usage
### 1. Import package
```python
from pathlib import Path
from md_head_num import MdHeadNum
```

### 2. Prepare the markdown file list

```python
md_files = list(Path("tests").glob("*.md"))
md_files  # [PosixPath('tests/test1.md'), PosixPath('tests/test2.md')]
```

### 3. Create an instance of `MdHeadNum`

```python
mn = MdHeadNum(md_files, max_level=5)
```

### 4. read markdown file and get the numbering 

```python
mn.numbering()
```

### 5. Numbered markdown file `save` and `save_as`

```python
# mn.save()  # Note: This will overwrite the original file
mn.save_as("_Numbered")  # This will save the numbered(Example: test1_Numbered.md) file with a suffix
```
