Skip to content

Commit 2e1869d

Browse files
committed
Update README.md
1 parent d79a7f3 commit 2e1869d

File tree

1 file changed

+34
-13
lines changed

1 file changed

+34
-13
lines changed

README.md

+34-13
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@ You can set parameters in the package's settings, such as page and border size.
1313

1414
![markdown-pdf](https://raw.githubusercontent.com/travs/markdown-pdf/master/assets/testpdf.png)
1515

16-
#### Note on styles
16+
### Tips
17+
18+
#### User styles
1719

1820
Note that user styles will have to be encapsulated in a `.markdown-body` selector to override the default stylesheets, like this:
1921

@@ -25,19 +27,38 @@ Note that user styles will have to be encapsulated in a `.markdown-body` selecto
2527
}
2628
```
2729

30+
#### Page breaks
2831

29-
#### Heart it? Hate it?
30-
Feel free to run `apm star 'markdown-pdf'` or give some feedback :smile:
32+
Page breaks can be added with this element:
33+
34+
```html
35+
<div style="page-break-after: always;"></div>
36+
```
37+
38+
#### Image paths
39+
40+
If you have trouble rendering an image, you may have to use a relative path:
3141

32-
##### Special thanks to these folks
42+
```
43+
# this doesn't work:
44+
![logo](/assets/logo.png)
45+
46+
# but this does
47+
![logo](./assets/logo.png)
48+
```
49+
50+
### Heart it? Hate it?
51+
52+
Feel free to run `apm star 'markdown-pdf'` or give some feedback :smile:
3353

34-
- [@BlueHatbRit](https://github.com/blueHatbRit): for helping integrate the essential [`mdpdf`](https://github.com/bluehatbrit/mdpdf) converter module
35-
- [@schmurphy](https://github.com/NKMR6194): [#11](https://github.com/travs/markdown-pdf/pull/11)
36-
- [@NKMR6194](https://github.com/NKMR6194): [#51](https://github.com/travs/markdown-pdf/pull/51), [#83](https://github.com/travs/markdown-pdf/pull/83)
37-
- [@Nicnl](https://github.com/Nicnl): [#28](https://github.com/travs/markdown-pdf/pull/28)
38-
- [@brianchung808](https://github.com/brianchung808): [#34](https://github.com/travs/markdown-pdf/pull/34)
39-
- [@hdmi](https://github.com/hdmi): [#53](https://github.com/travs/markdown-pdf/pull/53)
40-
- [@CumpsD](https://github.com/CumpsD): [#59](https://github.com/travs/markdown-pdf/pull/59)
41-
- [@pydolan](https://github.com/pydolan): [#72](https://github.com/travs/markdown-pdf/pull/72), [#74](https://github.com/travs/markdown-pdf/pull/74)
42-
- [@Galadirith](https://github.com/Galadirith): [#88](https://github.com/travs/markdown-pdf/pull/88)
54+
#### Special thanks to these folks
4355

56+
- [@BlueHatbRit](https://github.com/blueHatbRit)
57+
- [@jooola](https://github.com/jooola)
58+
- [@NKMR6194](https://github.com/NKMR6194)
59+
- [@Nicnl](https://github.com/Nicnl)
60+
- [@brianchung808](https://github.com/brianchung808)
61+
- [@hdmi](https://github.com/hdmi)
62+
- [@CumpsD](https://github.com/CumpsD)
63+
- [@pydolan](https://github.com/pydolan)
64+
- [@Galadirith](https://github.com/Galadirith)

0 commit comments

Comments
 (0)