generated from spatie/package-skeleton-laravel
-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
d568908
commit b812b49
Showing
1 changed file
with
92 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,92 @@ | ||
# Basics of Markdown | ||
Markdown is the most popular markup language that can be used to format documents. It can be used to create *websites*,*ebooks*,*email*,*chats in discussions forums*. | ||
|
||
## Topics | ||
1. Paragraphs | ||
|
||
MD expects a full line space to show texts in a different line else it joins text in the same line. | ||
2. Text decorations | ||
|
||
MD can write **bold** texts, ~~italiic~~ *italic* texts | ||
3. Headings | ||
No of #'s represent the type of heading. Github will automatically add id's to headings, so the text will be automatically linked. | ||
## This is h2 | ||
### This is h3 | ||
4. Links | ||
|
||
[My Github](https://github.com/bhupendra1011 "all repos") account.[Bhupendra][1] github repo. | ||
|
||
5. Images | ||
Images can be used just like links. ![Alt txt](img url) | ||
|
||
!["cat Img"](http://placekitten.com/200/200) | ||
|
||
Thumbnails images can also be used which links to larger image | ||
[<img src="http://placekitten.com/20/20">](http://placekitten.com/200/200) | ||
|
||
6. Ordered and Unordered Lists | ||
|
||
Coding Best Practices: | ||
|
||
* Keep code DRY | ||
* Writing Unit Test cases | ||
* Checking cross-browser support | ||
|
||
Steps to merge branch: | ||
|
||
1. Create a branch from feature | ||
1. commit your changes | ||
1. push your changes | ||
1. raise a pull request | ||
|
||
7. Code Blocks | ||
|
||
This is super helpful when posting any code snippet | ||
|
||
|
||
```js | ||
const fn = () => alert("some fn"); | ||
``` | ||
|
||
|
||
|
||
|
||
```css | ||
.hide { | ||
display:none | ||
} | ||
``` | ||
|
||
|
||
Also can show code difference | ||
|
||
|
||
```diff | ||
var x = 10; | ||
- const counter = 0; | ||
+ let counter = 0 | ||
``` | ||
|
||
|
||
|
||
8. Tables | ||
|
||
Tables can be generated with headings and text alignment option | ||
|
||
|Stocks|Price| | ||
|:-----:|------:| | ||
|TCS|230| | ||
|YES Bank|500| | ||
|
||
|
||
|
||
Cool Tips | ||
|
||
* [Grammarly](https://marketplace.visualstudio.com/items?itemName=znck.grammarly) extension can eliminate typo and grammar mistakes | ||
* [ScreenTOGif](https://www.screentogif.com/) to record videos in GIF format | ||
* Upload GIF's to [giphy](https://giphy.com/) to embed them into blog posts. | ||
* [Stackedit](https://stackedit.io/) for Markdown Editing in Browser. | ||
|
||
|
||
This template was copied from: | ||
[This dev.to post](https://dev.to/bhupendra1011/how-to-write-blog-posts-markdown-4hg8) |