Create web content was a serious challenge 10 years ago. Now you only need some knowledge of github, a few hours of Jekyll configuration, and that is it! Of course, you also need to use markdown, but it is pretty easy.
This language is what engineers use to document their code. When coding you do not have time to create very pretty documentation, you can not waste time beautiflying a manual, but you also can not distribute your manuals in plain text (not now). So markdown has been developed to do that type of work, simplifying how to write a cool manual with just a few text enrichment rules.
In markdown you can create simple text, italic text, bold text, and even italic-bold text, you just need to remember.
_italic text_
to create italic
**bold text**
to create bold
**_italic-bold text_**
to create italic-bold
Also, you just see how to create a list using -
in the code.
Speaking of code, I just used “`” to create words intended to mean code words, but you can even create whole blocks of code in this way:
pwd
ls -lh /path/to/folder
dmesg
So reviewing stuff that we can create is very easy:
code
-
at the beginning (or with 1.
to have an ordered list).So, having text is very important, however, there are other types of structures that can communicate more effective messages that are usually complex. For example, you can make a link very easy: [words displayed](url)
. And if such pointed resource is an image:
Another common structure that can be implemented very easy are tables:
| Header | Column |
|--|--|
| item 1 | item 2 |
| item 3 | item 4 |
results in
Header | Column |
---|---|
item 1 | item 2 |
item 3 | item 4 |
So, with all the structures you can implement on markdown
you can create any type of content. However, if you connect your code (using kramdown
from jekyll
) to platforms such as github-pages. You can even use \(LaTeX\) code to create some equations:
\[E=mc^{2}\]
Maybe you are a fan of emojis. Good news, there is a plugin jemoji
that you can use to
And finally, you could combine all these structures to have a very interesting way to communicate all the things that plain text can not.
Mathjax | Emojis | Code |
---|---|---|
\(E=mc^{2}\) | R |
|
\(\frac{\lambda_{i}}{\alpha^{\sqrt{n}}}\) | perl |
Setting up things here could be easier.