Skip to content

Commit c120f7e

Browse files
committed
README updates (added list of features)
1 parent 3dff8e5 commit c120f7e

File tree

1 file changed

+23
-14
lines changed

1 file changed

+23
-14
lines changed

Diff for: README.md

+23-14
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
1-
# mdtopdf
21

32
[![CI][badge-build]][build]
43
[![GoDoc][go-docs-badge]][go-docs]
54
[![License][badge-license]][license]
65

7-
## Introduction: Markdown to PDF
6+
## Markdown to PDF
7+
8+
A CLI utility which, as the name implies, generates PDF from Markdown.
9+
810
This package depends on two other packages:
911
- The [gomarkdown](https://github.com/gomarkdown/markdown) parser to read the markdown source
1012
- The `fpdf` package to generate the PDF
1113

1214
Both of the above are documented at [Go Docs](http://godocs.org).
1315

14-
The tests included here are from the BlackFriday package.
15-
See the "testdata" folder.
16-
The tests create PDF files and thus while the tests may complete
17-
without errors, visual inspection of the created PDF is the
18-
only way to determine if the tests *really* pass!
16+
## Features
1917

20-
The tests create log files that trace the [gomarkdown](https://github.com/gomarkdown/markdown) parser
21-
callbacks. This is a valuable debug tool showing each callback
22-
and data provided in each while the AST is presented.
18+
- Syntax highlighting (for code blocks)
19+
- Dark and light themes
20+
- Pagination control (using horizontal lines - especially useful for presentations)
21+
- Page Footer (consisting of author, title and page number)
22+
- Support of non-Latin charsets and multiple fonts
23+
24+
## Supported Markdown elements
2325

24-
## Supported Markdown
25-
The supported elements of markdown are:
2626
- Emphasized and strong text
2727
- Headings 1-6
2828
- Ordered and unordered lists
@@ -32,7 +32,16 @@ The supported elements of markdown are:
3232
- Links
3333
- Code blocks and backticked text
3434

35-
How to use of non-Latin fonts/languages is documented in a section below.
35+
## Tests
36+
The tests included here are from the BlackFriday package.
37+
See the "testdata" folder.
38+
The tests create PDF files and thus while the tests may complete
39+
without errors, visual inspection of the created PDF is the
40+
only way to determine if the tests *really* pass!
41+
42+
The tests create log files that trace the [gomarkdown](https://github.com/gomarkdown/markdown) parser
43+
callbacks. This is a valuable debug tool showing each callback
44+
and data provided in each while the AST is presented.
3645

3746
## Limitations and Known Issues
3847

@@ -175,7 +184,7 @@ $ go run md2pdf.go -i russian.md -o russian.pdf \
175184
```
176185
177186
178-
# Note to Self
187+
### Post release note
179188
180189
In order to update `pkg.go.dev` with latest release, the following will do the trick.
181190
Essentially, it is creating a module and then running the go get command for the

0 commit comments

Comments
 (0)