owned this note changed 2 years ago
Published Linked with GitHub

HackMD tutorial

Step 1: # and titles

#number indicates title hierarchy until 6#s represents tags

Step 2: layout stying

three seperators "```" blocks out a section for code 
  • star sign "*" is bullet point
  • dash bracket "-[]" is checklist
  1. numbers+dot initiates a numeric list

greater sign ">" preps a quote in grey

three colons ":::"blocks out a colored comment section when paired with a code

success is green

info is blue

warning is yellow

danger is red

spoiler holds collapsible details

Step 3: text styling

  • Bold: wrapped by two ** / cmd+ B
  • Italic: wraped by one * / cmd + I
  • Superscript: wrapped by one ^
  • Subscript: wraped by one ~
  • Crossed: wraped by two ~~
  • Highlight: wraped by two ==
  • color-coded code blocks: add code language=start line number
const list = [10, 20]; console.log(list.map(x => (x * x)))
  • soft wrap / code line auto-formating: add ! after code language specification
const veryLongLine = list.map(doSomething1).map(doSomething2).map(doSomething3).join(", ").toLocaleLowerCase('en-US')

Image Not Showing Possible Reasons
  • The image file may be corrupted
  • The server hosting the image is unavailable
  • The image path is incorrect
  • The image format is not supported
Learn More →
Hint: You can also apply styling from the toolbar at the top
Image Not Showing Possible Reasons
  • The image file may be corrupted
  • The server hosting the image is unavailable
  • The image path is incorrect
  • The image format is not supported
Learn More →
of the editing area.

Drag-n-drop image from your file system to the editor to paste it!

Step 4: collaboration

Click on the Sharing menu

Image Not Showing Possible Reasons
  • The image file may be corrupted
  • The server hosting the image is unavailable
  • The image path is incorrect
  • The image format is not supported
Learn More →
to collaborate

permalink setting demo

how to link content:

[link title](https://)

link title

a bracket and a colon defines a link

[link title]: https://

  1. Register and sign-in to HackMD
  2. Set Permalink for this note
  3. Copy and share the link with your team

Image Not Showing Possible Reasons
  • The image file may be corrupted
  • The server hosting the image is unavailable
  • The image path is incorrect
  • The image format is not supported
Learn More →
HackMD Tutorials

Features Tutorials
GitHub Sync
Browser Extension
Book Mode
Slide Mode
Share & Publish
  • LaTeX for formulas

\[ x = {-b \pm \sqrt{b^2-4ac} \over 2a} \]

  • UML diagrams
Alice->Bob: Hello Bob, how are you?
Note right of Bob: Bob thinks
Bob-->Alice: I am good thanks!
Note left of Alice: Alice responds
Alice->Bob: Where have you been?
  • Auto-generated Table of Content:[ToC]
  • Embed YouTube Videos:{%youtube PJuNmlE74BQ %}
Select a repo