[RUBY] À propos de la notation Markdown

C'est le premier message de Qiita. J'ai hâte de travailler avec vous.

"Écrivez et partagez vos connaissances en programmation en notation Markdown"

Et, comme c'est le cas par défaut au début de l'écran de publication de Qiita, la notation Markdown est souvent utilisée dans l'industrie de la programmation, qu'il s'agisse de requête d'extraction Qiita, README ou GitHub. Au début, je pensais faire un peu en regardant le site de référence, mais ~~ j'avais beaucoup de façons inattendues de le faire, et c'était gênant ~~ Je pensais que je n'avais pas encore besoin de m'en souvenir, mais récemment En apprenant à le faire un par un, j'ai décidé de l'afficher sous forme de mémorandum et de ma pratique.

Tout d'abord, à propos de Markdown

Qu'est-ce que Markdown

Markdown est l'une des notations (langage de balisage) pour écrire des phrases. Markdown a été développé par John Gruber en tant que format qui peut convertir du texte brut facile à écrire et à lire, comme lors de la rédaction d'un e-mail, en un document HTML qui a l'air bien dans une certaine mesure. Il présente les caractéristiques suivantes.

• Description simple et facile à retenir
• Clarifier la structure des phrases --Markdown peut être compris tel quel
• Vous pouvez lire et écrire plus confortablement en utilisant une application compatible.
• L'extension est ".md"

... Apparemment ...

Vous trouverez ci-dessous un exemple de fichier README d'application Rails.

README

table des utilisateurs

Association

• has_many :friends
• has_many :comments

Comme vous pouvez le voir, READ ME est indispensable pour l'application, et la description qu'il contient est la notation Markdown, il est donc nécessaire de se souvenir au moins de la notation Markdown.

Ensuite, je présenterai un extrait de ce que j'utilise souvent.

--Si vous mettez "#" au début et laissez un espace demi-largeur, ce sera le sens de l'en-tête et sera mis en évidence en majuscule. (Même signification que la balise h1) "#" Est le plus grand, et à mesure que vous l'augmentez une par une, les lettres majuscules deviennent de plus en plus petites et vous pouvez écrire jusqu'à six "#######" d'affilée.

――Si vous mettez "-" au début et laissez un espace demi-largeur, "・" sera ajouté.

• Vous pouvez créer une ligne horizontale en insérant au moins trois "---" et "-" d'affilée.

Ce qui précède était la description que j'utilise souvent. La méthode de description ci-dessus n'est vraiment qu'une partie, donc si vous êtes intéressé, j'espère que vous pourrez apprendre d'un site approprié. (Lol) Même ainsi, tous les gens de Qiita publient des articles en notation Markdown, donc je pense que je suis probablement le moins familier (pas maîtriser) la notation Markdown parmi les personnes qui ont posté sur Qiita, donc je vais me consacrer à partir de maintenant. J'aimerais venir. Merci d'être resté avec nous jusqu'à présent.

Remarque: Tous les "#" et "-" en notation Markdown ne seront pas reflétés correctement à moins qu'ils ne soient écrits en demi-largeur. De plus, laissez un espace demi-largeur. Veuillez noter qu'il ne sera pas reflété en plein angle!

Le site auquel j'ai fait référence cette fois

[Artis Co., Ltd. Blog utile pour les entreprises et l'utilisation informatique](https://www.asobou.co.jp/blog/bussiness/markdown#:~:text=Markdown%EF%BC%88%E3%83%9E% E3% 83% BC% E3% 82% AF% E3% 83% 80% E3% 82% A6% E3% 83% B3% EF% BC% 89% E3% 81% A8% E3% 81% AF,% E3 % 81% AB% E3% 82% 88% E3% 81% A3% E3% 81% A6% E9% 96% 8B% E7% 99% BA% E3% 81% 95% E3% 82% 8C% E3% 81 % BE% E3% 81% 97% E3% 81% 9F% E3% 80% 82)