b c" /> b c"/> PenguinCode – Default Markdown Formatting in Pelican 3.7.1

Default Markdown Formatting in Pelican 3.7.1

Posted on 2017-10-12 17:05 in Blog

There are bunch of great resources for Markdown formatting. This post is primarily for my own benefit, as a quick reference on how to use the formatting for the handful that I use regularly.

Pelican Style Guide

Markdown Extensions

Basic Text Formatting

Style Syntax Example
Bold ** text ** text
Italic * text * text
Underline <u> text </u> text
Strikethrough <del> text </del> text

Headings

# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5

Heading 1

Heading 2

Heading 3

Heading 4

Heading 5

Links

Raw Link: https://www.google.com

https://www.google.com

Text Link

[Displayed Text](https://www.google.com)
Displayed Text

Text Link with Alt Text

[Displayed Text](https://www.google.com "alt text")
Displayed Text

Direct link

reference links Text [1]: https://www.google.com "google"

Tables

| Header Left | Header Right |
|---------------|--------------|
| Cell Left | Cell Right |

Header Left Header Right
Cell Cell Right

Code

Inline code is encased with back-ticks.

`in-line-code`

in-line-code

Code blocks are identified by three back-ticks, followed by the language for syntax formatting.

```java
public class Code {
public static void main(String[] args){
return;
}
}

```java
public class Code {
    public static void main(String[] args){
        return;
    }
}

No Formatting

  a <pre>  b </pre> c