Mark Down Language - ZheWang711/Notebook_Algo GitHub Wiki

Mark down language

Contents

Block Elements

  • To create a paragraph, simply create a block of text that is not separated by one or more blank lines. Blocks of text separated by one or more blank lines will be parsed as paragraphs.

  • Break line: space + space + enter

  • Header: # header You mays end your header with any number of #

  • block quotes: prefixing the first line of each paragraph need to quote with >
    block quote example

    full reference
    https://github.com/adam-p/markdown-here/wiki

  • lists

    • ordered lists: prefix each line with a number
    • unordered lists: prefix each line with *,+, or -
    • list iterms can contain multiple paragraphs, however it must be indented by at least 4 spaces

  • code blocks

    code
    ``` python
    print('hello world')
    ```
    instance

    print('hello world')

  • Horizontal rules: three or more * or _

    example

Span Elements

  • Inline link [text](/ZheWang711/Notebook_Algo/wiki/internal-ref)
  • Reference link [GitHub](https://github.com/)
  • Italics *italics text*
  • Bold **bold text**
  • Code wrap the code in ``
  • Image ![alt text](link)

Miscellaneous

Tricks

  • Internal Reference: use all lowercase in the anchor portion of the URL.
    This is how the Content section in this page is established.
    Example
    If you have a wiki page named Questions.md and you create heading tags ## Latest and ### Ask Your Question, working links would be like this:

    From the same page:

    • [See the latest questions](#latest)
    • [Ask Me Something](#ask-your-question)

    From a different page:

    • [See the latest questions](Questions#latest)
    • [Ask Me Something](Questions#ask-your-question)