←

How to format a note

This is a placeholder. Open the file how-to-format-a-note.md to see the Markdown behind each example. Delete the file to remove this page.

Every note starts with a top block between two lines of three dashes. It holds the title, the date as YYYY-MM-DD, and an optional description for search results. The file name becomes the web address, so use lowercase letters, digits and dashes.

Paragraphs

Write plain lines. Leave one empty line between paragraphs.

This is a second paragraph.

Bold and italic

Wrap words in two asterisks for bold: **bold**.

Wrap words in one asterisk for italic: *italic*.

Use three for both: ***both***.

Links

Put the words in square brackets and the address in round brackets: Kei Gowda is written [Kei Gowda](https://keigowda.com/).

Subheadings

Start a line with two hashes and a space for a subheading, like ## Subheadings above. Do not use a single hash; the title in the top block is the page's main heading.

Numbered lists

Start each line with a number, a period and a space:

  1. First item
  2. Second item
  3. Third item

Bulleted lists

Start each line with a dash and a space:

Quotes

Start a line with a greater-than sign and a space:

This is a quote.

Code

Wrap a short piece of code in single backticks, like git push.

For a longer block, put three backticks on the line before it and on the line after it:

for note in notes:
    print(note)