Markdown
- https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax
- https://daringfireball.net/projects/markdown/syntax#backslash
#Links
- Link [1]
- [foobar][2]
- [Link](http://google.com)
- [example@example.com](mailto:example@example.com)
- [Call Me!](tel:1111111)
[1]: http://google.com
[2]: http://google.com
#Language Highlight
Github use Linguist to perform language detection and to select third-party grammars for syntax highlighting. You can find out which keywords are valid in the languages YAML file.
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html
As code
```ruby
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html
```
#Diffs
def example do
- :ok
+ {:ok, :more_stuff}
end
```diff
def example do
- :ok
+ {:ok, :more_stuff}
end
```
#Creating diagrams
Supported: Mermaid, GeoJSON, TopoJSON, and ASCII STL. Read More
```mermaid
graph TD;
A-->B;
A-->C;
B-->D;
C-->D;
```
graph TD;
A-->B;
A-->C;
B-->D;
C-->D;
#Special Blocks @ Github
[!NOTE] Highlights information that users should take into account, even when skimming.
> [!NOTE]
> Highlights information that users should take into account, even when skimming.
[!TIP] Optional information to help a user be more successful.
> [!TIP]
> Optional information to help a user be more successful.
[!IMPORTANT] Crucial information necessary for users to succeed.
> [!IMPORTANT]
> Crucial information necessary for users to succeed.
[!WARNING] Critical content demanding immediate user attention due to potential risks.
> [!WARNING]
> Critical content demanding immediate user attention due to potential risks.
[!CAUTION] Negative potential consequences of an action.
> [!CAUTION]
> Negative potential consequences of an action.
#Tables
#Alternative headers
Instead ## or # you can:
h2.Header
---------
h1.Header
=========