> For the complete documentation index, see [llms.txt](https://openai.gitbook.io/code-cheatsheets/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://openai.gitbook.io/code-cheatsheets/markdown.md). # markdown ## [Markdown Guide](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) ### Headers ## H1 ### H2 #### H3 **H4** **H5** **H6** ## Alt-H1 ### Alt-H2 ### Emphasis *asterisks* or *underscores* Strong emphasis double **asterisks** or **underscores**. Combined emphasis with **asterisks and *****underscores***. Strikethrough uses two tildes. ~~Scratch this.~~ ### Lists 1. First ordered list item 2. Another item ⋅⋅\* Unordered sub-list. 3. Actual numbers don't matter, just that it's a number ⋅⋅1. Ordered sub-list 4. And another item. ⋅⋅⋅You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown). ⋅⋅⋅To have a line break without a paragraph, you will need to use two trailing spaces.⋅⋅ ⋅⋅⋅Note that this line is separate, but within the same paragraph.⋅⋅ ⋅⋅⋅(This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.) * Unordered list can use asterisks * Or minuses * Or pluses ### Links [I'm an inline-style link](https://www.google.com) \[I'm an inline-style link with title]\( "Google's Homepage") [I'm a reference-style link](https://www.mozilla.org) [I'm a relative reference to a repository file](https://github.com/jsfuentes/Code-Cheatsheet/tree/f70ca1d51a4c3b0254a56450701f278258c1821a/blob/master/LICENSE/README.md) [You can use numbers for reference-style link definitions](http://slashdot.org) Or leave it empty and use the [link text itself](http://www.reddit.com). URLs and URLs in angle brackets will automatically get turned into links. or and sometimes example.com (but not on Github, for example). Some text to show that the reference links can follow later. ### Images Here's our logo (hover to see the title text): Inline-style: ![Logo Title Text 1](https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png) Reference-style: ![Logo Title Text 2](https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png) ### Code and Syntax Highlighting Code blocks are part of the Markdown spec, but syntax highlighting isn't. However, many renderers -- like Github's and Markdown Here -- support syntax highlighting. Which languages are supported and how those language names should be written will vary from renderer to renderer. Markdown Here supports highlighting for dozens of languages (and not-really-languages, like diffs and HTTP headers); to see the complete list, and how to write the language names, see the highlight.js demo page. Inline `code` has `back-ticks around` it. Inline code has back-ticks around it. Blocks of code are either fenced by lines with three back-ticks \`\`\`, or are indented with four spaces. I recommend only using the fenced code blocks -- they're easier and only they support syntax highlighting. ```javascript var s = "JavaScript syntax highlighting"; alert(s); ``` ```python s = "Python syntax highlighting" print s ``` ``` No language indicated, so no syntax highlighting. But let's throw in a tag. ``` ### Blockquotes > Blockquotes are very handy in email to emulate reply text. This line is part of the same quote. Quote break. > This is a very long line that will still be quoted properly when it wraps. Oh boy let's keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can *put* **Markdown** into a blockquote. ### Raw HTML Definition listIs something people use sometimes.Markdown in HTMLDoes \*not\* work \*\*very\*\* well. Use HTML *tags*. ### Horizontal Rule Three or more... Hyphens Asterisks Underscores ### LineBreaks Here's a line for us to start with. This line is separated from the one above by two newlines, so it will be a *separate paragraph*. This line is also a separate paragraph, but... This line is only separated by a single newline, so it's a separate line in the *same paragraph*. ### Youtube They can't be added directly but you can add an image with a link to the video like this: Or, in pure Markdown, but losing the image sizing and border: [![IMAGE ALT TEXT HERE](http://img.youtube.com/vi/YOUTUBE_VIDEO_ID_HERE/0.jpg)](http://www.youtube.com/watch?v=YOUTUBE_VIDEO_ID_HERE) Referencing a bug by #bugID in your git commit links it to the slip. For example #1. #### TYPORA WEB CONTENT See the Pen [Fancy Animated SVG Menu](https://codepen.io/jeangontijo/pen/OxVywj/) by Jean Gontijo ([@jeangontijo](https://codepen.io/jeangontijo)) on [CodePen](https://codepen.io). ### TYPORA Graph Plugins Mermaid ``` graph LR A[Hard edge] -->B(Round edge) B --> C{Decision} C -->|One| D[Result one] C -->|Two| E[Result two] ``` Flowchart ```` ```flow st=>start: Start op=>operation: Your Operation cond=>condition: Yes or No? e=>end st->op->cond cond(yes)->e cond(no)->op ``` ```` Sequence ``` Alice->Bob: Hello Bob, how are you? Note right of Bob: Bob thinks Bob-->Alice: I am good thanks! ```