Guide on how to style your readme different from anyone else
Bold
Italic
Strikethrough
Strong
Emphasis
Deleted
Inserted
Highlighted
Superscript
Subscript
Code
Preformatted
Keyboard
Sample output
| Boxed text |
- Unordered list
- Ordered list
- Term
- Definition
title of the content
content body
{
support: "codeblock to"
}
Sir Charles Antony Richard Hoare
"Long quote text here..."
| example | ![]() |
v2.1.0 Beta Stable
@username @designer
MIT GPL
API REST JWT CRUD
漢
H1
H2
H3
H4
H5
H6
Default
- test
+ test
!test
@@ test @@
===================================================================
***************
*** 1,3 ****
--- 1,3 ----
diff --test
We Can Also choose to put them beside eachother
H1
H2
H3
H4
H5
H6
Default
- test
+ test
!test
@@ test @@
===================================================================
***************
*** 1,3 ****
--- 1,3 ----
diff --test
You dont need to wrap it in kbd either this is without
H1
H2
H3
H4
H5
H6
Default
- test
+ test
!test
@@ test @@
===================================================================
***************
*** 1,3 ****
--- 1,3 ----
diff --test
Ever thought about putting pictures next to a text? well you can!
Style to left
🔹Make some text
🔹Make some text
🔹Make some text
Style to center
Style to center
🔹Make some text
🔹Make some text
🔹Make some text
Style to right
🔹Make some text
🔹Make some text
🔹Make some text
Another way you can style
🔹Make some text
🔹Make some text
🔹Make some text
Clean Start Look
Put a short bio or whatever you want here about your project something short but catchy explaining your project
Features ⁀➴
Feature 1 test test test test test test test test test test
Feature 2 test test test test test test test test
Feature 3 test test test test test test
Supports status code filtering
│
│
🢃
$ HeaderRefer2 We can also add context
$ HeaderRefer3 or wrap it up
HeaderRefer1
HeaderRefer2
HeaderRefer3
🢇⁀🐧 ˗˗˗ˏˋ🖳ˎˊ˗˗˗ 🪟⁀🡾
Linux/macOS
Run these commands:
git clone https://github.com/zebbern/dezcrwl.git
cd example
chmod +x example.sh
./example.sh
git clone https://github.com/zebbern/dezcrwl.git
cd example
chmod +x example.sh
./example.sh
Windows
Run these commands:
git clone https://github.com/zebbern/dezcrwl.git
cd example
example.sh
git clone https://github.com/zebbern/dezcrwl.git
cd example
example.sh
Now run example -h anywhere in terminal
You can also use these to get a users attention:
[!NOTE] Useful information that users should know, even when skimming content.
[!TIP] Helpful advice for doing things better or more easily.
[!IMPORTANT]
Key information users need to know to achieve their goal.
[!WARNING] Urgent info that needs immediate user attention to avoid problems.
[!CAUTION] Advises about risks or negative outcomes of certain actions.