Skip to content

Commit 7487cde

Browse files
committed
CLI script section in README.
1 parent 20faf8a commit 7487cde

3 files changed

Lines changed: 12 additions & 4 deletions

File tree

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -219,11 +219,13 @@ In the created file `plantuml.pdf`, you will see the following result:
219219

220220
You can find a more detailed description of the plugins [here](plugins.md).
221221

222-
## Example
222+
## Command Line Interface script.
223223

224-
As an example, you can download the [pdf file](examples/markdown_pdf.pdf) created from this md file.
224+
As an example, you can download the [pdf file](examples/markdown_pdf.pdf) created from this README.
225225
This [Python script](makepdf.py) was used to create the PDF file.
226226

227+
You can create your own CLI script, tailored to your needs, using this script as a starting point.
228+
227229
## Development
228230

229231
```bash

README_ru.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -213,11 +213,13 @@ pdf.save("plantuml.pdf")
213213

214214
Вы можете ознакомиться с более подробным [описанием плагинов](plugins_ru.md).
215215

216-
## Пример
216+
## Скрипт командной строки (CLI).
217217

218-
В качестве примера вы можете загрузить созданный из этого md файла [pdf файл](examples/markdown_pdf_ru.pdf).
218+
В качестве примера вы можете загрузить созданный из этого README [pdf файл](examples/markdown_pdf_ru.pdf).
219219
Для создания pdf файла использовался [этот скрипт](makepdf.py) Python.
220220

221+
Используя этот скрипт в качестве отправной точки, вы можете создать собственный скрипт командной строки, адаптированный под ваши нужды.
222+
221223
## Разработка
222224

223225
```bash

makepdf.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
"""Call:
2+
3+
python makepdf.py input.md output.pdf
4+
"""
15
import sys
26
from markdown_pdf import MarkdownPdf, Section
37

0 commit comments

Comments
 (0)