Skip to content

test.md

Latest commit

 

History

History
303 lines (212 loc) · 4.88 KB

test.md

File metadata and controls

303 lines (212 loc) · 4.88 KB
version 1.0
date May 27, 2025
status draft
license CC-BY 4.0
authors Ninn Langel<ninn@unlockopen.com>

Markdown to PDF : a guide for the Open Regulatory Compliance Working Group

Note This document demonstrates the different styles and elements that can be included. The title page prior to this first page was generated because the title page tag was set at the beginning of the document :

<!-- [[titlepage]] -->

The table of content on the next page is created where the table of content tag is set :

<!-- [[toc]] -->

The table of content defaults to using H2 and H3 headings. If you need to use more heading levels, you can do so by adding an array of levels after the tag :

<!-- [[toc]][3,4,5] -->

Headings

H1 is for the document's title

It displays mid-page and should be used once. If it contains a semicolon, it will be split into two parts for better visual impact.

H2 is for section headings

They will always generate a page break.

H3 is for subsection headings

They do not generate a page break unless they'd be at the end of a page.

H4

H5
H6
# H1 Heading
## H2 Heading
### H3 Heading
#### H4 Heading
##### H5 Heading
###### H6 Heading

Text Formatting

The basic text formattings can be achieved easily:

  • Italic
  • Bold
  • Bold Italic
  • Strikethrough
  • Superscript
  • Subscript
  • Inline code
*Italic*
**Bold**
***Bold Italic***
~~Strikethrough~~
<sup>Superscript</sup>
<sub>Subscript</sub>
`Inline code`

Lists

Unordered

  • Item 1
    • Subitem 1.1
      • Subitem 1.1.1
  • Item 2

Ordered

  1. First
  2. Second
    1. Second - subitem
    2. Second - subitem 2
  3. Third
- Item 1
  - Subitem 1.1
    - Subitem 1.1.1
- Item 2

1. First
2. Second
   1. Second - subitem
   2. Second - subitem 2
3. Third

Links & Images

[GitHub](https://github.com)
![Test image](assets/test-image.png "Test image")

Blockquotes & Callouts

This is a standard blockquote.

This one displays as a normal blockquote in github, and I can style it later, and we could directly throw in metadata on the law text to display nicely if usefull.

Note

This is a GitHub note callout.

Warning

This is a GitHub warning callout.

Tip

This is a GitHub tip callout.

Important

This is a GitHub important callout.

Caution

This is a GitHub caution callout.

> This is a standard blockquote.

> [!Note]
> This is a GitHub note callout.

> [!Warning]
> This is a GitHub warning callout.

> [!Tip]
> This is a GitHub tip callout.

> [!Important]
> This is a GitHub important callout.

> [!Caution]
> This is a GitHub caution callout.

Code

Inline

Here is some inline code.

Block

def hello_world():
    print("Hello, world!")
# Bash example
echo "Hello, Markdown!"
`inline code`
def hello_world():
    print("Hello, world!")
echo "Hello, Markdown!"

Tables

Syntax Description Example
Header Title Example Header
Paragraph Text Example Text 
| Syntax      | Description     | Example           |
|-------------|-----------------|-------------------|
| Header      | Title           | Example Header    |
| Paragraph   | Text            | Example Text      |

Task Lists

  • Write the introduction
  • Add more examples
  • Review the document
- [x] Write the introduction
- [ ] Add more examples
- [ ] Review the document

Footnotes

Here is a simple footnote.1 And another reference to it.1

Here is a simple footnote.[^1] And another reference to it.[^1]

[^1]: This is the footnote.

Horizontal Rule

---

HTML Block

This is a raw HTML block in Markdown.
<div style="color: red; font-weight: bold;">This is a raw HTML block in Markdown.</div>

Mermaid.js graphics

Flowchart Example

flowchart TD
  A[Start] --> B{Is it working?}
  B -- Yes --> C[Continue]
  B -- No --> D[Fix it]
  D --> B
Loading

Sequence Diagram Example

sequenceDiagram
  participant User
  participant App
  User->>App: Request data
  App-->>User: Return data
Loading

Gantt Chart Example

gantt
  title Project Timeline
  dateFormat  YYYY-MM-DD
  section Development
  Design      :done,    des1, 2024-05-01,2024-05-07
  Coding      :active,  code1, 2024-05-08, 7d
  Testing     :         test1, after code1, 5d
Loading

Footnotes

  1. This is the footnote. ↩ ↩2