├── README.md
├── README_fr.md
├── README_pt-BR.md
├── Translation:Spanish.md
└── _config.yml
/README.md:
--------------------------------------------------------------------------------
1 | # Markdown Tutorial
2 | 
3 |
4 | ## Hello, welcome to my tutorial for markdown. 👋
5 | In this tutorial you will learn the most basics things about Markdown. 👩🏫👨🏫
6 |
7 | - Spanish version available [here](https://github.com/LewisVo/Markdown-Tutorial/blob/master/Translation:Spanish.md) 🇪🇸.
8 | - Portuguese version available [here](https://github.com/LewisVo/Markdown-Tutorial/blob/master/README_pt-BR.md) 🇵🇹.
9 | - French version available [here](https://github.com/luongvo209/Markdown-Tutorial/blob/master/README_fr.md) 🇫🇷.
10 |
11 | *******
12 | Tables of contents
13 | 1. [What is Markdown?](#whatismarkdown)
14 | 2. [Why use Markdown?](#why)
15 | 3. [Tools for Markdown](#tools)
16 | 4. [Markdown Syntax](#syntax)
17 |
18 | *******
19 |
20 |
21 |
22 | ## What is markdown ?
23 | According to Wikipedia :
24 |
25 | >*Markdown is a lightweight markup language with plain text formatting syntax designed so that it can be converted to HTML and many other formats using a tool by the same name. Markdown is often used to format readme files, for writing messages in online discussion forums, and to create rich text using a plain text editor.*
26 |
27 |
28 | `SIMPLY: IT'S JUST ANOTHER TYPE OF TEXT FILE, LIKE .txt .doc ....( now it's .md :laughing:) AND IT HAS SOME SPECIAL SYNTAX.`
29 |
30 |
31 | *There is no clearly defined Markdown standard. This has led to fragmentation as different vendors write their own variants of the language to correct flaws or add missing features.. A list of markdown flavour is available [here](https://github.com/jgm/CommonMark/wiki/Markdown-Flavors).*
32 |
33 | From now, this guide will mainly focus on Github Flavoured Markdown.
34 |
35 | ## Why use markdown?
36 | Because it's :
37 | * **EZ** : The syntax is so easy that you can learn in a minute or two then write without noticing anything weirdo or geeky.
38 | * **FAST** : It saves time compared to other types of text files/formats. It helps boost the productivity and workflows of writer.
39 | * **CLEAN** : Both the syntax and output are clean, not messy with our eyes and simple to manage.
40 | * **FLEXIBLE** : With just a little set-up, your text will be translated cross any platform out there, editable in any text-editing software and convertible to a wide array of formats.
41 |
42 | **In short**, normal users will find it useful in any cases, especially when you are in need of something better than plain text but less functional than Microsoft Word.
43 | **For Developers**, if you are lazy to write HTML code , you will love markdown. **Moreover**, **Github** and many sites favor markdown for readme file of projects. That means you gonna meet markdown in your life one way or another.
44 |
45 |
46 | ## Tools for markdown
47 | As said above, any editors can be used to edit markdown. However, there are a few tools that may be useful for you when it comes to edit markdown.
48 | * **[*Stackedit*](https://stackedit.io)** : Ok, you can stop reading right now. Click the link then start your markdown tour in an eziest way ever. Just type normal text then use your mouse, click click done. You dont have to know the syntax. It's good, but it will make you reliant and most developers prefers keyboards.
49 | * **[*Dillinger*](http://dillinger.io/)** : Online tool, support live view (split screen) and export to html. Nothing too special but very neat and handy.
50 | * **[*Typora*](https://www.typora.io/)** : Available for Mac and Windows, minimal, distraction free, live view seemlessly, bundled with a lot of other stuffs like Images, Lists, Tables, Code Fences, Math Blocks, YAML, Front Matters,Toc,...
51 | * **[*Atom*](https://atom.io/)** : popular hackable text editor (you may be using this). Yeah, this is versatile. Markdown Support? Just a part of it but is greatly built in.
52 | * **[*Minimalist Markdown*](https://chrome.google.com/webstore/detail/minimalist-markdown-edito/pghodfjepegmciihfhdipmimghiakcjf?hl=en)** : Chrome app. Works everywhere if you have Chrome installed ( this is my favorite one).
53 | * **[*Macdown*](http://macdown.uranusjr.com/)** : best for Mac.
54 | * **[*MarkdownPad*](http://markdownpad.com/)** : best for Windows.
55 | * **[*Remarkable*](https://remarkableapp.github.io/)** : best for Linux.
56 | * **[*GITBOOK*](http://www.gitbook.com/)** : GitBook is a modern publishing toolchain. Making both writing and collaboration easy. It does both support Markdown and have a close relation with the beloved Github.
57 |
58 |
59 | ## Markdown Syntax
60 | All Syntax can be found [here](https://daringfireball.net/projects/markdown/syntax) . It would take a lot of effort to describe syntax in text (they will be formatted) so please consider this table below for the whole basics syntax.
61 |
62 | | Format | Syntax | Example |
63 | | ------|-----|-----|
64 | | Italic | \*Text\* | *This is italic* |
65 | | Bold | \*\*Bold\*\* | **This is bold** |
66 | | Inline links | \[Description text\](url here) | A [link](http://www.github.com) |
67 | | Images | \ | An image  |
68 | | Link+images | \[\\](url to a page)\] | Click me [](https://www.youtube.com) |
69 | | Footnotes | I have more \[^1\] to say. \[^1\]: say it down here. | Hey,Please read the note below this table. |
70 | | Line breaks | Double space + enter | |
71 | | Unordered Lists | \* Item1 \*Item 2 | |
72 | | Ordered Lists | 1. Item a 2. Item b | - itema
- itemb
- itemc
- itemd
|
73 | | Mixed Lists | 1. Item 1 * item 1a | - itema
|
74 | | Block quote | \> Quoted text | Stay Hungry Stay Foolish
|
75 | | Preformatted | Begin each line with,two spaces or more to,make text look,e x a c t l y,like,you,type i,t. | Begin each line with,two spaces or more to,make text look,e x a c t l y,like,you,type i,t. |
76 | | Code | \`Insert Code\` | `cout<<"Hello world";` |
77 | | Code block/ Syntax highlighting | \`\`\`insert code\`\`\` | Hey,Please read the note below this table. |
78 | | Headers | \#, \##, \###, \####, \#####, \###### (from h1 to h6) | This is a h3 header
|
79 | | Strike through | \~~Insert text here\~~ | ~~I am dead~~ |
80 | | Tables | \| Tables \| Are \| Cool \| \|\----------\|\:\-------------\:\|------\:\| \| col 1 is\| left-aligned \| $1600 \| |  |
81 | |Footnotes| Footnote[\^1\]
[\^1\]: Text reference | Here is a simple footnote[^1]. With some additional text after it. |
82 | [^1]: My footnote reference.
83 |
84 |
85 |
86 | Note: **Footnote** actually doesnt render properly in table, but it kinda looks like this
87 |
88 | 
89 |
90 | The same goes for **block code/syntax hightlighting**. It kinda looks like this picture :
91 |
92 | .
93 |
94 | These characteristics are dependent upon each markdown flavour.
95 |
96 |
97 | ## Useful notes :
98 | * Markdown allows you to use backslash escapes to generate literal characters which
99 | would otherwise have special meaning in Markdown’s formatting syntax. One commonly used backslash escape character is : \
100 | `So? \*This\* isnt italic anymore but is surrounded by literal asterisks.`
101 |
102 | * Youtube videos require some additional work.
103 | ```
104 | They can't be added directly but you can add an image with a link to the video like this:
105 |
108 | ```
109 | * Markdown does support Emojii :laughing: :laughing: :kissing_heart: :innocent: :green_heart: ( get some emojies [here](http://www.emoji-cheat-sheet.com/) )
110 | * You can use \
tag to force line break.
111 | * Double space then enter if you want to make a new line if there is trouble making new lines.
112 | * Seeing is not as good as practicing. You can either create a markdown file for yourself to practice or do it online [here](http://www.markdowntutorial.com).
113 | * Footnotes and syntax highlighting are not part of the original markdown and are only supported by certain flavors of markdown (Feedback from [Sean Brody](https://goo.gl/ASZwEn))
114 | * Any URL (like http://www.github.com/) will be automatically converted into a clickable link.
115 | * Markdown table support is designed to handle most tables for most people; it doesn’t cover all tables for all people. If you need complex tables you will need to create them by hand or with a tool specifically designed for your output format.
116 | * Using image and links, you can create some colorful assets at render time. Badges like this are typical examples that you can find all over Github [](https://github.com/) [](https://github.com/)
117 | [](https://github.com/)
118 | [](https://github.com/)
119 | [](https://www.linkedin.com/)
120 | [](https://github.com/)
121 | ( get some badges [here](https://shields.io/) )
122 |
123 | * Using code block syntax with diff language to generate colored text. There are still some limitations such as can not style the text inside and few colors. This can be applicable when you want to highlight some note or to show difference between two code block
124 |
125 | ```diff
126 | - text in red
127 | + text in green
128 | ! text in orange
129 | # text in gray
130 | @@ text in purple (and bold)@@
131 | ```
132 |
133 |
134 | * Add beautiful note or warning section into markdown GitHub:
135 | > **Note**:
136 |
137 | > **Warning**:
138 |
139 | * In markdown file on Github, with code block syntax and Mermaid language specifed, we can draw many kinds of diagram. More syntax and sample diagrams [here](https://mermaid-js.github.io/)
140 |
141 | - Class diagram
142 | ```mermaid
143 | classDiagram
144 | class Duck{
145 | -weight
146 | +swim()
147 | +quack()
148 | }
149 | ```
150 | - Sequence diagram
151 | ```mermaid
152 | sequenceDiagram
153 | participant dotcom
154 | participant iframe
155 | dotcom->>iframe: loads html w/ iframe url
156 | ```
157 | - Flowchart
158 | ```mermaid
159 | graph TD;
160 | A-->B;
161 | A-->C;
162 | B-->D;
163 | C-->D;
164 | ```
165 |
166 | ###### Author: *Vo Tran Thanh Luong*. Also, I would like to thank all the contributors/translators for your work making this greater.
167 |
168 |
--------------------------------------------------------------------------------
/README_fr.md:
--------------------------------------------------------------------------------
1 | # Markdown Tutorial
2 | 
3 |
4 | Bonjour, bienvenue dans mon tutoriel sur le Markdown.
5 | Dans ce tutoriel, vous apprendrez les bases du Markdown.
6 | La version espagnole est disponible [ici](https://github.com/LewisVo/Markdown-Tutorial/blob/master/Translation:Spanish.md).
7 | La version portugaise est disponible [ici](https://github.com/LewisVo/Markdown-Tutorial/blob/master/README_pt-BR.md).
8 |
9 | *******
10 | Table des matières
11 | 1. [Qu'est-ce que le Markdown ?](#whatismarkdown)
12 | 2. [Pourquoi utiliser le Markdown?](#why)
13 | 3. [Outils pour le Markdown](#tools)
14 | 4. [La syntaxe du Markdown](#syntax)
15 |
16 | *******
17 |
18 |
19 |
20 | ## Qu'est-ce que le Markdown ?
21 | Selon Wikipedia :
22 |
23 | >*Le Markdown est un langage de balisage léger avec une syntaxe de formatage de texte brut conçu pour être converti en HTML ainsi qu'en d'autres format en utilisant un outil du même nom. Le Markdown est souvent utilisé pour rédiger des fichiers readme, pour écrire des messages dans des forums de discussion en ligne et pour créer des textes riches en utilisant un éditeur de texte brut.*
24 |
25 |
26 | `TOUT SIMPLEMENT : C'EST JUSTE UN AUTRE TYPE DE FICHIER TEXTE, COMME .txt .doc ....( ICI C'EST .md :laughing:) ET IL POSSÈDE UNE SYNTAXE SPÉCIALE.`
27 |
28 |
29 | *Il n'y a pas de standard Markdown clairement défini. Cela a conduit à une fragmentation étant donné que les différents fournisseurs écrivent leurs propres variantes du langage pour corriger les défauts ou ajouter des fonctionnalités manquantes... Une liste des versions de Markdown est disponible [ici](https://github.com/jgm/CommonMark/wiki/Markdown-Flavors).*
30 |
31 | Pour l'instant, ce guide se concentre principalement la version Markdown de GitHub.
32 |
33 | ## Pourquoi utiliser le Markdown ?
34 | Parce que c'est :
35 | * **FACILE** : La syntaxe est tellement simple que vous pouvez apprendre en une minute ou deux, puis écrire sans trouver quoi que ce soit bizarre ou geek.
36 | * **RAPIDE** : Cela fait gagner du temps comparé aux autres types de fichiers/formats texte. Cela aide à accélérer la productivité et le flux de travail du rédacteur.
37 | * **PROPRE** : La syntaxe et le rendu sont tous deux clairs, ne font pas mal aux yeux et sont simples à gérer.
38 | * **FLEXIBLE** : Avec un peu de configuration, votre texte sera traduit sur toutes les plateformes, sera modifiable dans tout logiciel d'édition et convertible dans un large choix de formats.
39 |
40 | **En bref**, les utilisateurs réguliers le trouveront utile dans tous les cas, en particulier quand vous avez besoin de quelque chose de mieux que du texte brut mais de moins fonctionnel que Microsoft Word.
41 | **Pour les développeurs**, si vous êtes trop paresseux pour écrire du code HTML, vous adorerez le Markdown. **De plus**, **Github** et beaucoup d'autres sites privilégient le Markdown pour le fichier readme des projets. Cela signifie que vous allez rencontrer le Markdown d'une façon ou d'une autre.
42 |
43 |
44 | ## Outils pour le Markdown
45 | Comme mentionné ci-dessus, tous les éditeurs peuvent être utilisés pour éditer du Markdown. Cependant, il existe quelques outils qui pourraient vous être utiles pour l'édition du Markdown.
46 | * **[*Stackedit*](https://stackedit.io)** : Ok, vous pouvez arrêter de lire tout de suite. Cliquez sur le lien et commencez votre visite du markdown de la plus simple des manières. Tapez juste du texte normal et utilisez votre souris, clic clic, c'est fait. Vous n'avez pas besoin de connaître la syntaxe. C'est bien, mais vous en serez dépendant et la plupart des développeurs préfèrent les claviers.
47 | * **[*Dillinger*](http://dillinger.io/)** : Outil en ligne, supporte le *live view* (écran partagé) et l'export au format html. Rien de très spécial mais très soigné et pratique.
48 | * **[*Typora*](https://www.typora.io/)** : Disponible pour Mac et Windows, minimaliste, sans aucune distraction, *live view* parfait, comprend d'autres choses comme les Images, Listes, Tableaux, Blocs de Code, Blocs de Mathématiques, YAML, Front Matters, Toc, ...
49 | * **[*Atom*](https://atom.io/)** : Éditeur de texte populaire (vous l'utilisez peut-être). Ouais, il est polyvalent. Supporte le Markdown ? Ça n'en est qu'une partie et c'est très bien construit.
50 | * **[*Minimalist Markdown*](https://chrome.google.com/webstore/detail/minimalist-markdown-edito/pghodfjepegmciihfhdipmimghiakcjf?hl=en)** : App Google Chrome. Fonctionne partout si Chrome est installé (c'est mon préféré).
51 | * **[*Macdown*](http://macdown.uranusjr.com/)** : le meilleur pour Mac.
52 | * **[*MarkdownPad*](http://markdownpad.com/)** : le meilleur pour Windows.
53 | * **[*Remarkable*](https://remarkableapp.github.io/)** : le meilleur pour Linux.
54 | * **[*GITBOOK*](http://www.gitbook.com/)** : GitBook est un outil de publication moderne qui simplifie la rédaction et la collaboration. Il supporte le Markdown et entretient une relation proche avec notre bien-aimé Github.
55 |
56 |
57 | ## La syntaxe du Markdown
58 | Toute la syntaxe peut être trouvée [ici](https://daringfireball.net/projects/markdown/syntax) . Il faudrait beaucoup d'efforts pour retranscrire la syntaxe en texte (ils seraient formatés). Jetez donc un oeil au tableau ci-dessous pour toute la syntaxe de base.
59 |
60 | | Format | Syntaxe | Exemple |
61 | | ------|-----|-----|
62 | | Italique | \*Texte\* | *C'est en italique* |
63 | | Gras | \*\*Gras\*\* | **C'est en bold** |
64 | | Lien | \[Description\](url ici) | Un [lien](http://www.github.com) |
65 | | Images | \ | Une image  |
66 | | Lien + images | \[\\](url vers une page)\] | Cliquez sur moi [](https://www.youtube.com) |
67 | | Notes de bas de page | J'ai plus de choses \[^1\] à dire. \[^1\]: Dites-le ici. | Hey, lisez la note sous ce tableau s'il vous plaît. |
68 | | Sauts de ligne | Double espace + entrée | |
69 | | Listes non-ordonnées | \* Item1 \*Item 2 | |
70 | | Listes ordonnées | 1. Item a 2. Item b | - itema
- itemb
- itemc
- itemd
|
71 | | Listes mélangées | 1. Item 1 * item 1a | - itema
|
72 | | Citations | \> Texte cité | Stay Hungry Stay Foolish
|
73 | | Préformatté | Commencez chaque ligne avec,deux espaces ou plus pour,faire que le texte soit,e x a c t e m e n t,comme,vous, le, tapez. | Commencez chaque ligne avec,deux espaces ou plus pour,faire que le texte soit,e x a c t e m e n t,comme,vous, le,tapez. |
74 | | Code | \`Insérez du code\` | `cout<<"Hello world";` |
75 | | Bloc de code/ Mise en évidence de la syntaxe | \`\`\`insérez du code\`\`\` | Hey, lisez la note sous ce tableau s'il vous plaît. |
76 | | Titres | \#, \##, \###, \####, \#####, \###### (de h1 à h6) | C'est un titre h3
|
77 | | Barré | \~~Insérez du texte ici\~~ | ~~Je suis mort~~ |
78 | | Tableau | \| Tables \| Are \| Cool \| \|\----------\|\:\-------------\:\|------\:\| \| col 1 is\| left-aligned \| $1600 \| |  |
79 |
80 |
81 |
82 | Note : Les **notes de pied de page** ne s'affichent pas correctement dans les tableaux (et la prévisualisation GitHub), mais cela ressemble à quelque chose comme ceci : 
83 |
84 | C'est la même chose pour les **blocs de code/mise en évidence de la syntaxe**. Cela ressemble à ce que l'on voit sur cette image :
85 | .
86 |
87 | Ces caractéristiques dépendent de la version Markdown.
88 |
89 | ## Notes utiles :
90 | * Le Markdown vous permet d'utiliser des échappements antislash pour générer des caractères littéraux qui
91 | sinon auraient un sens particulier avec la syntaxe de formatage Markdown. Un des caractères antislash d'échappement est : \
92 | `Donc ? \*Ce\* n'est plus en italique mais c'este entouré par des astérisques littéraux.`
93 |
94 | * Les vidéos Youtube nécessitent un peu plus de travail.
95 | ```
96 | Elles ne peuvent pas être ajoutées directement mais vous pouvez ajouter une image avec un lien vers la vidéo comme ceci :
97 |
100 | ```
101 | * Markdown supporte les emojis : :laughing: :laughing: :kissing_heart: :innocent: :green_heart: (vous trouverez des emojis [ici](http://www.emoji-cheat-sheet.com/) )
102 | * Vous pouvez utiliser les balises \
pour forcer un saut de ligne.
103 | * Double espace puis Entrée si vous voulez faire une nouvelle ligne et qu'il y a un souci pour en faire.
104 | * Voir n'est pas aussi bien que pratiquer. Vous pouvez soit vous créer un fichier markdown pour pratiquer ou le faire en ligne [ici](http://www.markdowntutorial.com).
105 | * Les notes de pied de page et mise en évidence de la syntaxe ne font pas partie du Markdown original et ne sont supportés que par certaines versions de Markdown (Information de [Sean Brody](https://goo.gl/ASZwEn))
106 | * Toute URL (comme http://www.github.com/) sera automatiquement convertie en un lien cliquable.
107 | * Le support de tableau Markdown est conçu pour gérer la plupart des tableaux pour la majorité des gens ; cela n'englobe pas tous les tableaux pour tout le monde. Si vous avez besoin de tableaux complexes, vous devrez les créer à la main ou avec un outil spécifiquement conçu pour votre format de sortie.
108 | ```J'ai eu tellement de mal à rendre possible le tableau ci-dessus```
109 |
110 | ###### Auteur : *Vo Tran Thanh Luong*.
111 | ###### Traducteur : *Butel Jérôme*.
112 |
--------------------------------------------------------------------------------
/README_pt-BR.md:
--------------------------------------------------------------------------------
1 | # Markdown Tutorial
2 | 
3 |
4 | Olá, bem vindos ao meu tutorial de Markdown.
5 | Neste tutorial você aprenderá o básico sobre Markdown.
6 | Versão em espanhol disponível [aqui](https://github.com/LewisVo/Markdown-Tutorial/blob/master/Translation:Spanish.md).
7 |
8 | *******
9 | Tabelas de conteúdo
10 | 1. [O que é Markdown?](#whatismarkdown)
11 | 2. [Porque usar Markdown?](#why)
12 | 3. [Ferramentas para Markdown](#tools)
13 | 4. [Sintaxe de Markdown](#syntax)
14 |
15 | *******
16 |
17 |
18 |
19 | ## O que é Markdown ?
20 | De acordo com a Wikipedia :
21 |
22 | >*Markdown é uma linguagem de marcação leve com sintaxe de formatação de texto simples projetada para que ela possa ser convertida em HTML e muitos outros formatos usando uma ferramenta com o mesmo nome. Markdown é usado frequentemente para formatar arquivos readme, para escrever mensagens em fóruns de discussão on-line e para criar texto rico usando um editor de texto simples.*
23 |
24 |
25 | `SIMPLESMENTE: É APENAS OUTRO TIPO DE ARQUIVO DE TEXTO, COMO .txt .doc .... (agora é .md :risos:) E COM UMA SINTAXE ESPECIAL.`
26 |
27 |
28 | *Não existe um padrão de Markdown claramente definido. Isso levou à fragmentação, pois fornecedores diferentes escrevem suas próprias variantes do idioma para corrigir falhas ou adicionar recursos faltantes. Uma lista de versões de Markdown está disponível [aqui](https://github.com/jgm/CommonMark/wiki/Markdown-Flavors).*
29 |
30 | A partir de agora, este guia se concentrará principalmente na versão Markdown para Github .
31 |
32 | ## Porque usar Markdown?
33 | Porque é :
34 | * **FÁCIL** : A sintaxe é tão fácil que você pode aprender em um minuto ou dois, em seguida, escreva sem perceber nada estranho ou nerd.
35 | * **RÁPIDO** : Ele economiza tempo em comparação com outros tipos de arquivos / formatos de texto. Isso ajuda a aumentar a produtividade e os fluxos de trabalho do escritor.
36 | * **LIMPO** : Tanto a sintaxe como a saída são limpas, sem confusão com nossos olhos e simples de gerenciar.
37 | * **FLEXÍVEL** : Com apenas algumas configurações, o seu texto será traduzido atravessando qualquer plataforma lá fora, editável em qualquer software de edição de texto e conversível para uma ampla variedade de formatos.
38 |
39 | **Em resumo**, os usuários comuns acharão útil em todos os casos, especialmente quando você precisar de algo melhor que o texto simples, mas menos funcional do que o Microsoft Word.
40 | **Para desenvolvedores**, Se você é preguiçoso para escrever código HTML, você vai adorar o markdown. **Além disso**, **Github** e muitos sites favorecem o markdown para o arquivo readme de projetos. Isso significa que você vai encontrar o markdown em sua vida de uma forma ou de outra.
41 |
42 |
43 | ## Ferramentas para markdown
44 | Conforme mencionado acima, qualquer editor pode ser usado para editar o markdown. No entanto, existem algumas ferramentas que podem ser úteis para você quando se trata de editar markdown.
45 | * **[*Stackedit*](https://stackedit.io)** : Ok, você pode parar de ler agora. Clique no link e, em seguida, comece o seu turno de markdown de uma maneira mais rápida. Basta digitar o texto normal e depois usar o mouse, clique no botão. Você não precisa saber a sintaxe. É bom, mas fará você dependende, e a maioria dos desenvolvedores prefere os teclados.
46 | * **[*Dillinger*](http://dillinger.io/)** : Ferramenta on-line, suporte em exibição ao vivo (tela dividida) e exportação para html. Nada muito especial, mas muito limpo e acessível.
47 | * **[*Typora*](https://www.typora.io/)** : Disponível para Mac e Windows, mínimo, livre de distração, vista ao vivo sem parecer, empacotada com muitas outras coisas como Imagens, Listas, Tabelas, Cercas de Código, Blocos de Matemática, YAML, Front Matters, Toc, ...
48 | * **[*Atom*](https://atom.io/)** : Editor de texto popular hackeável (você pode estar usando isso). Sim, isso é versátil. Suporte Markdown? Apenas uma parte disso, mas é muito construído.
49 | * **[*Minimalist Markdown*](https://chrome.google.com/webstore/detail/minimalist-markdown-edito/pghodfjepegmciihfhdipmimghiakcjf?hl=en)** : Aplicativo do Google Chrome. Funciona em todos os lugares se você tiver o Chrome instalado (este é o meu favorito).
50 | * **[*Macdown*](http://macdown.uranusjr.com/)** : O Melhor para Mac.
51 | * **[*MarkdownPad*](http://markdownpad.com/)** : O Melhor para Windows.
52 | * **[*Remarkable*](https://remarkableapp.github.io/)** : O Melhor para Linux.
53 | * **[*GITBOOK*](http://www.gitbook.com/)** : O GitBook é uma ferramenta de publicação moderna. Facilitando a escrita e a colaboração. Ambos suportam a Markdown e têm uma estreita relação com o amado Github.
54 |
55 |
56 |
57 | ## Sintaxe do Markdown
58 | Toda a sintaxe pode ser encontrada [aqui](https://daringfireball.net/projects/markdown/syntax) . Seria necessário muito esforço para descrever a sintaxe no texto (eles serão formatados), então, considere esta tabela abaixo para toda a sintaxe básica.
59 |
60 | | Formato | Sintaxe | Exemplo |
61 | | ------|-----|-----|
62 | | Itálico | \*Text\* | *Isto está em itálico* |
63 | | Negrito | \*\*Bold\*\* | **Isto está em negrito** |
64 | | Links Inline | \[texto\](url aqui) | Um [link](http://www.github.com) |
65 | | Imagens | \ | Uma imagem  |
66 | | Link + Imagens | \[\\](url para a pagina)\] | Me clique [](https://www.youtube.com) |
67 | | Quebras de Linha | Double space + enter | |
68 | | Listas Não Ordenadas | \* Item1 \*Item 2 | - item1
- item2
|
69 | | Listas Ordenadas | 1. Item a 2. Item b | - itema
- itemb
|
70 | | Listas Mistas | 1. Item 1 * item 1a | - item1
|
71 | | Citação | \> Texto citado | Stay Hungry Stay Foolish
|
72 | | Preformatted | Comece cada linha com, dois espaços ou mais, faça o look do texto, e x a t a m e n t e, como, você, tipo i, s, t, o. | Comece cada linha com, dois espaços ou mais, faça o look do texto, e x a t a m e n t e, como, você, tipo i, s, t, o. |
73 | | Código | \`Insira o código\` | `cout<<"Hello world";` |
74 | | Bloco de Código/ Destaque de Sintaxe | \`\`\`Insira o código\`\`\` | Ei, leia a nota abaixo desta tabela. |
75 | | Títulos | \#, \##, \###, \####, \#####, \###### (from h1 to h6) | Isso é um título h3
|
76 | | Riscado | \~~Insira o texto aqui\~~ | ~~Eu estou morto~~ |
77 | | Tabelas | \| Tables \| Are \| Cool \| \|\----------\|\:\-------------\:\|------\:\| \| col 1 is\| left-aligned \| $1600 \| |  |
78 | |Notas de Rodapé| Notas de rodapé[\^1\]
[\^1\]: Refêrencia | Aqui está uma simples nota de rodapé[^1]. Com um texto adicional. |
79 | [^1]: Minha Referencia favorita.
80 |
81 |
82 |
83 | Nota: **Nota de rodapé** atualmente não renderiza direito na tabela, mas se parece com isso:
84 |
85 | 
86 |
87 | O mesmo vale para **Bloco de código/destaque de sintaxe**. Sua aparência é igual a da imagem abaixo:
88 |
89 | .
90 |
91 | Estas características dependem de cada versão de markdown.
92 |
93 | ## Notas úteis :
94 | * O Markdown permite que você use escapes de barra invertida para gerar caracteres literais que
95 | de outra forma teria um significado especial na sintaxe de formatação da Markdown. Um personagem de escape de barra invertida comumente usado é : \
96 | `Assim? \ * Este \ * não é mais itálico, mas é cercado por asteriscos literais.`
97 |
98 | * Os vídeos do Youtube requerem algum trabalho adicional.
99 | ```
100 | Eles não podem ser adicionados diretamente, mas você pode adicionar uma imagem com um link para o vídeo como este:
101 |
104 | ```
105 | * Markdown suporta Emoji :laughing: :laughing: :kissing_heart: :innocent: :green_heart: ( obter alguns emojis [aqui](http://www.emoji-cheat-sheet.com/) )
106 | * Você pode usar a tag \
para forçar uma quebra de linha.
107 | * O espaço duplo, em seguida, se você quiser fazer uma nova linha se houver problemas para criar novas linhas.
108 | * Ver não é tão bom como praticar. Você pode criar um arquivo de markdown para você praticar ou fazê-lo online [aqui](http://www.markdowntutorial.com).
109 | * As notas de rodapé e o destaque de sintaxe não fazem parte do Markdown original e são apenas suportados por certas versões de markdown (Feedback de [Sean Brody](https://goo.gl/ASZwEn))
110 | * Qualquer URL (Como http://www.github.com/) será automaticamente convertido em um link clicável.
111 | * O suporte à tabela Markdown é projetado para lidar com a maioria das tabelas para a maioria das pessoas; não cobre todas as tabelas para todas as pessoas. Se você precisa de tabelas complexas, você precisará criá-las manualmente ou com uma ferramenta especificamente projetada para o formato de saída.
112 | * Usando imagens e links, você pode criar alguns recursos coloridos no momento da renderização. Badges como este são exemplos típicos que você pode encontrar em todo o Github [](https://github.com/) [](https://github.com/)
113 | [](https://github.com/)
114 | [](https://github.com/)
115 | [](https://www.linkedin.com/)
116 | [](https://github.com/)
117 | ( get some badges [here](https://shields.io/) )
118 |
119 | * Usando a sintaxe do bloco de código diff para gerar texto colorido. Ainda existem algumas limitações como não conseguir estilizar o texto dentro da caixa diff e poucas cores para a formatação. Isso pode ser aplicável quando você deseja destacar alguma nota ou mostrar a diferença entre dois blocos de código
120 |
121 | ```diff
122 | - texto em vermelho
123 | + texto em verde
124 | ! texto em laranja
125 | # texto em cinza
126 | @@ texto em roxo (e negrito)@@
127 | ```
128 |
129 |
130 | * Para adicionar marcações de "Nota" e de "Aviso" deve-se usar a sintaxe abaixo:
131 | >
132 | > **Note**:
133 | >
134 | > **Warning**:
135 |
136 |
137 | * Em arquivo markdown no Github, com sintaxe de bloco de código e linguagem Mermaid, podemos desenhar vários tipos de diagrama. Mais sintaxe e diagramas de exemplo [aqui](https://mermaid-js.github.io/)
138 |
139 | - Diagrama de classe
140 | ```mermaid
141 | classDiagram
142 | class Pato{
143 | -peso
144 | +nada()
145 | +quack()
146 | }
147 | ```
148 | - Diagrama de sequência
149 | ```mermaid
150 | sequenceDiagram
151 | participant dotcom
152 | participant iframe
153 | dotcom->>iframe: carrega html com url do iframe
154 | ```
155 | - Fluxograma
156 | ```mermaid
157 | graph TD;
158 | A-->B;
159 | A-->C;
160 | B-->D;
161 | C-->D;
162 | ```
163 |
164 | ###### Author: *Vo Tran Thanh Luong*. Also, I would like to thank all the contributors/translators for your work making this greater.
165 |
166 | ###### Autor: *Vo Tran Thanh Luong*.
167 | ###### Tradução: *Héricles Emanuel*.
168 | ###### Correções: [*Alexander Santos*](https://github.com/Ronkiro).
169 |
--------------------------------------------------------------------------------
/Translation:Spanish.md:
--------------------------------------------------------------------------------
1 | # Tutorial de Markdown
2 | 
3 |
4 | Hola, ¡bienvenidos a mi tutorial de markdown!
5 | En este tutorial aprenderás los conceptos básicos sobre Markdown.
6 |
7 | *******
8 | Tabla de contenidos
9 | 1. [¿Qué es Markdown?](#qué-es-markdown)
10 | 2. [¿Por qué usar Markdown?](#porque)
11 | 3. [Herramientas para Markdown](#herramientas-para-markdown)
12 | 4. [Sintaxis de Markdown](#sintaxis-de-markdown)
13 |
14 | *******
15 |
16 |
17 | ## ¿Qué es markdown ?
18 | De acuerdo a Wikipedia:
19 |
20 |
21 | >*Markdown es un lenguaje de marcado ligero creado por John Gruber que trata de conseguir la máxima legibilidad y facilidad de publicación tanto en su forma de entrada como de salida, inspirándose en muchas convenciones existentes para marcar mensajes de correo electrónico usando texto plano. Se distribuye bajo licencia BSD y se distribuye como un componente (o al menos está disponible) en diferentes sistemas de gestión de contenidos (CMS). Markdown convierte el texto marcado en documentos XHTML utilizando html2text creado por Aaron Swartz. Markdown fue implementado originariamente en Perl por Gruber, pero desde entonces se ha traducido a multitud de lenguajes de programación, incluyendo PHP, Python, Ruby, Java y Common Lisp.*
22 |
23 |
24 | SIMPLEMENTE: ES ÚNICAMENTE OTRO TIPO DE ARCHIVO DE TEXTO, COMO .txt, .doc, ... (en realidad es .md :laughing: ) Y TIENE UNA SINTAXIS ESPECIAL.
25 |
26 |
27 |
28 | *No hay un estándar bien definido de Markdown. Esto ha provocado fragmentación, ya que varios fabricantes escriben sus propias versiones del lenguaje para corregir detalles o agregar características faltantes... Una lista de algunas versiones está disponible [acá](https://github.com/jgm/CommonMark/wiki/Markdown-Flavors).*
29 |
30 | A partir de acá, esta guía de enfocará principalmente en la versión propia de Github.
31 |
32 | ## ¿Por qué usar Markdown?
33 | Por que es:
34 |
35 | * **Super Fácil** : La sintáxis es tan fácil que puedes aprenderla en un minuto o dos, después escribir sin darte cuenta de nada raro o complejo.
36 | * **RÁPIDO** : Ahorra mucho tiempo comparado con otros tipos de archivos/formatos de texto. Ayuda a maximizar la productividad y los flujos de escritura.
37 | * **LIMPIO** : Ambos, la sintaxis y la salida son limpios, nada ilegibles a nuestra vista y simples de manejar.
38 | * **FLEXIBLE** : Con únicamente configuraciones simples, tu texto será traducido entre las plataformas que existan, editable en cualquier software de edición de textos y convertible a una amplia gama de formatos.
39 |
40 | **Brevemente**, los usuarios normales lo encontrarán útil en cualquier caso, especialmente cuando necesitas algo mejor que el texto plano pero menos funcional que MS Word.
41 | **Para desarrolladores**, si tienes pereza de escribir código HTML, amarás Markdown. **Más aún**, **Github** y muchos sitios favorecen markdown para archivos README en proyectos. Eso significa que necesitarás Markdown en tu vida de una manera u otra.
42 |
43 |
44 |
45 | ## Herramientas para Markdown
46 | Como se dijo anteriormente, cualquier editor puede ser usado para escribir Markdon. De cualquier forma, hay algunas herramientas que pueden ser útiles a la hora de editar Markdown.
47 |
48 | * **[*Stackedit*](https://stackedit.io)** : De acuerdo, puedes dejar de leer ahora mismo. Da click al link y empieza a tu viaje a Markdown de la manera más fácil posible. Únicamente escribe texto normal y usa tu mouse, click click, hecho. Es bueno, pero te hará dependiente y muchos desarrolladores prefieren los teclados.
49 | * **[*Dillinger*](http://dillinger.io/)** : Herramienta online, soporta vista previa en edición(pantalla dividida) y puedes exportar a HTML. Nada especial, pero muy bien hecho y útil.
50 | * **[*Typora*](https://www.typora.io/)** : Disponible para Mac y Windows, minimalista, libre de distracciones, vista previa sin interrupciones, cargado con muchas características como imágenes, listas, tablas, bloques de código, bloques de expresiones matemáticas, YAML, texto preliminar, tablas de contenido..., etc.
51 | * **[*Atom*](https://atom.io/)** : Editor muy popular y altamente configurable (tal vez lo estés usando), ¡Sí!, es versátil. ¿Soporte para markdown?, es una pequeña parte del editor, pero ya viene incluida.
52 | * **[*Minimalist Markdown*](https://chrome.google.com/webstore/detail/minimalist-markdown-edito/pghodfjepegmciihfhdipmimghiakcjf?hl=en)** : App de Chrome. Funciona en todos lados si tienes Chrome instalado (es mi favorita).
53 | * **[*Macdown*](http://macdown.uranusjr.com/)** : Lo mejor para Mac.
54 | * **[*MarkdownPad*](http://markdownpad.com/)** : Lo mejor para Windows.
55 | * **[*Remarkable*](https://remarkableapp.github.io/)** : Lo mejor para Linux.
56 | * **[*GITBOOK*](http://www.gitbook.com/)** : GitBook es una moderna caja de herramientas. Hace escribir y colaborar fácil. Soporta Markdown y está relacionado con nuestro querido Github.
57 |
58 |
59 | ## Sintaxis de Markdown
60 | Toda la sintaxis se puede encontrar [acá](https://daringfireball.net/projects/markdown/syntax) . Cuestaun poco escribir sintaxis en texto (ya que será parseada y formateada), así que por favor considera esta tabla de abajo como la sintaxis básica de Markdown.
61 |
62 |
63 | | Formato | Syntaxis | Ejemplo |
64 | | ------|-----|-----|
65 | | Itálica | \*Texto\* | *Esto es itálica* |
66 | | Negritas | \*\*Negritas\*\* | **Esto es negritas** |
67 | | Links inline | \[Descripción del texto\](url acá) | Un [link](http://www.github.com) |
68 | | Imágenes | \ | Una imagen  |
69 | | Link + imágenes | \[\\](url a una página)\] | Haz [](https://www.youtube.com) |
70 | | Pies de página | Tengo más \[^1\] que decir. \[^1\]: dilo acá. | Oye, por favor lee esta nota debajo de esta tabla. |
71 | | Salto de línea | Doble espacio + enter | |
72 | | Listas no ordenadas | \* Item1 \*Item 2 | |
73 | | Listas ordenadas | 1. Item a 2. Item b | - itema
- itemb
- itemc
- itemd
|
74 | | Listas combinadas | 1. Item 1 * item 1a | - itema
|
75 | | Cita | \> Texto citado | Mantente insatisfecho, mantente humilde.
|
76 | | Pre formato | Empieza cada línea con, dos espacios o más para, hacer el texto verse, e x a c t a m e e n t e, como, tú, lo escr.i.b.e.s.|
77 | | Código | \`Inserta código\` | `cout<<"Hello world";` |
78 | | Bloque de código/ Realtado de sintaxis | \`\`\`inserta código\`\`\` | Oye, por favor lee la nota debajo de esta tabla.
79 | | Encabezados | \#, \##, \###, \####, \#####, \###### (desde h1 a h6) | Esto es un encabezado h3
|
80 | | Texto tachado | \~~Inserta texto acá\~~ | ~~Morí~~ |
81 | | Tablas | \| Las tablas \| son \| geniales \| \|\----------\|\:\-------------\:\|------\:\| \| col 1 es\| alineada a la izquierda \| $1600 \| |  |
82 |
83 |
84 |
85 | Nota: **Nota al pie** de hecho, no se ve correctamente en una tabla (y en vista previa de Github).
86 | Pero es parecida [a](http://i.imgur.com/pmeBr28.png)
87 |
88 | Lo mismo va para **bloques de código/resaltado de sintaxis**.
89 | Se ve como .
90 |
91 | Estas características dependen de cada versión de markdown.
92 |
93 | ## Notas útiles:
94 | * Markdown permite usar diagonal invertida para generar caracteres que de otra forma serían reconocidos por la sintaxis especial. Un caracter muy usado comúnmente como escape es \
95 | `Luego, \*ESTO\* no es itálica, sin embargo está precedido literalmente por asteriscos.`
96 | * Los videos de Youtube requieren un poco más de trabajo adicional.
97 | ```
98 | No pueden ser agregados diretamente, sin embargo, puedes agregar una imágen con un link al video de la siguiente manera:
99 |
102 | ```
103 | * Markdown soporta Emojis :laughing: :laughing: :kissing_heart: :innocent: :green_heart: ( consulta algunos emojis [acá](http://www.emoji-cheat-sheet.com/) )
104 | * Puedes usar la etiqueta \
para forzar un salto de línea.
105 | * Doble espacio y enter si quieres agregar una nueva línea.
106 | * Ver no es tan bueno como practicar. Puedes crear un archivo markdown para que practiques o hacerlo online [acá](http://www.markdowntutorial.com).
107 | * Notas al pie y resaltado de sintaxis no son parte de la versión original de Markdown y solo son soportadas por ciertas versiones. (Retroalimentación de [Sean Brody](https://goo.gl/ASZwEn))
108 | * Cualquier URL (como http://www.github.com/) será convertida en un link activo.
109 | * El soporte a las tablas de Markdon está diseñado para soportar la mayoría de tablas para la mayoría de personas; no cubre todas las tablas para todas las personas. Si necesitas tablas más complejas necesitarás herramientas específicamente diseñadas para ello o escribirlas a mano.
110 | ```Me costó demasiado hacer la tabla de arriba```
111 |
112 | ###### Author: *Vo Tran Thanh Luong*.
113 | ###### Traducido al español por: *Javier Mejia*
114 |
115 |
--------------------------------------------------------------------------------
/_config.yml:
--------------------------------------------------------------------------------
1 | theme: jekyll-theme-cayman
--------------------------------------------------------------------------------