Skip to content

Commit 5aadf2d

Browse files
committed
long line wrap workaround
1 parent 1c8ebef commit 5aadf2d

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

FAQ.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ raw code
6969
```
7070
~~~
7171

72-
## How do I know what markdown formatting is supported (there are so many different version)?
72+
## How do I know what Markdown formatting is supported (there are so many different version)?
7373

7474
In `osert.rb`, `markdown` [is used](https://github.com/noraj/OSCP-Exam-Report-Template-Markdown/blob/50aeada2b6171c3a4fe96d91a10f632d752063f2/generate.rb#L82-L93) as `--to` formatter for `pandoc` which means it will use [Pandoc markdown](https://pandoc.org/MANUAL.html#pandocs-markdown) (similar to GFM [[1](https://docs.gitlab.com/ee/user/markdown.html)] [[2](https://github.github.com/gfm/)].) Else other syntaxes (commonmark, GFM, MultiMarkdown, PHP Markdown Extra) are supported too, see [pandoc options](https://pandoc.org/MANUAL.html#option--to). If you want to use another syntax you can generate your report using the [manual command](https://github.com/noraj/OSCP-Exam-Report-Template-Markdown#manual).
7575

@@ -85,7 +85,14 @@ Issue tracking:
8585
- this project: [#21](https://github.com/noraj/OSCP-Exam-Report-Template-Markdown/issues/21)
8686
- upstream: [#122](https://github.com/Wandmalfarbe/pandoc-latex-template/issues/122)
8787

88-
A workaround is to prepare the markdown file with with a script (ex: [awk script](https://github.com/noraj/OSCP-Exam-Report-Template-Markdown/discussions/66)) to hard wrap lines on code blocks yourself. It's like adding newlines manually but automatically.
88+
A workaround is to prepare the markdown file with a script (ex: [awk script](https://github.com/noraj/OSCP-Exam-Report-Template-Markdown/discussions/66)) to hard wrap lines on code blocks yourself. It's like adding newlines manually but automatically.
89+
90+
Another workaround, is to add these two lines in the YAML front-matter of your Markdown file:
91+
92+
```yaml
93+
header-includes:
94+
- \fvset{breaksymbol={}, breakanywheresymbolpre={}, breakanywhere, breaknonspaceingroup}
95+
```
8996
9097
## What is the list of supported languages for code blocs syntax highlight?
9198
@@ -166,7 +173,7 @@ noraj
166173

167174
Command: `diff -u note.a note.b`
168175

169-
Output of the command formated into a Markdown fenced code block with `diff` language class:
176+
Output of the command formatted into a Markdown fenced code block with `diff` language class:
170177

171178
~~~text
172179
```diff
@@ -214,7 +221,7 @@ Display of the rendered diff code block:
214221

215222
Related to [this issue](https://github.com/noraj/OSCP-Exam-Report-Template-Markdown/issues/58).
216223

217-
Due to using Pandoc and a LaTeX template for formating the report, raw backslash (`\`) are interpreted as a control sequence for LaTeX commands.
224+
Due to using Pandoc and a LaTeX template for formatting the report, raw backslash (`\`) are interpreted as a control sequence for LaTeX commands.
218225

219226
So if your markdown report contains some plain backslash, you'll get an error like below:
220227

@@ -231,7 +238,7 @@ l.314 I am NT AUTHORITY\SYSTEM
231238
232239
There are two solutions:
233240
234-
1. Put it in markdown code
241+
1. Put it in Markdown code
235242
2. Escape it
236243
237244
### Solution n°1: Markdown code

0 commit comments

Comments
 (0)