Tag: Markdown

Markdown syntax guide

pCP Team 26 October 2020 pCP 6.1.0 Publishing
This page contains examples of Markdown syntax.

Headings

The following HTML <h1><h6> elements represent six levels of section headings.

Example:
# This is an H1 - Do not use - Defined by title/description front matter
## This is an H2 - added to table of contents
### This is an H3 - added to table of contents
#### This is an H4
##### This is an H5 - label
###### This is an H6
Result:

This is an H2 - added to table of contents

This is an H3 - added to table of contents

This is an H4

This is an H5 - label
This is an H6

Paragraphs

Paragraphs are separated by empty lines. To create a new paragraph, press <return> twice.

Convert HTML to Markdown

pCP Team 11 July 2022 pCP 6.1.0 Publishing  •
The piCorePlayer Documentation source is mostly written in Markdown. So sometimes it is necessary to convert existing HTML pages into Markdown using an online service for inclusion in the documentation.

Steps

Step 1 - Copy HTML source
  • In the web page, select View source (ctrl+u in Edge)
  • Copy the HTML code by:
    • Clicking on the HTML window to set focus.
    • Highlight all source (ctrl+a).
    • Copy highlighted source (ctrl+c).
Step 2 - Convert HTML to Markdown
  • Open Turndown—click Turndown - HTML to Markdown.
    • Set Heading style to atx.
    • Set Bullet to -.
    • Set Code block style to fenced.
  • Paste source in left HTML window (ctrl+v).
  • Copy result from right MARKDOWN window (ctrl+a, ctrl+c).
Step 3 - Tidy up Markdown
  • Paste into text editor (ctrl+c).
  • Remove head and trailing rubbish.

More information

The Software and Information is provided "as is" without warranty of any kind, either express or implied, including without limitation any implied warranties of condition, uninterrupted use, merchantability, fitness for a particular purpose, or non-infringement.
Raspberry Pi is a trademark of the Raspberry Pi Foundation.