[RUBY] About Markdown notation

This is Qiita's first post. I look forward to working with you.

"Write and share your programming knowledge in Markdown notation"

And, as it is the default at the beginning of Qiita's posting screen, Markdown notation is often used in the programming industry, whether it is Qiita, README, or GitHub pull request. At the beginning, I thought I'd do it a little by looking at the reference site, but ~~ I had a lot of unexpected ways to do it, and it was troublesome ~~ I thought I didn't have to remember it yet, but recently As I learned how to do it one by one, I decided to post it as a memorandum and my practice.

First of all, about Markdown

What is Markdown

Markdown is one of the notations (markup language) for writing sentences. Markdown was developed by John Gruber as a format that can convert plain text that is easy to write and read, such as when writing an email, into an HTML document that looks good to some extent. It has the following features.

--Simple and easy-to-remember description --Clarify the structure of sentences --Markdown can be understood as it is --You can read and write more comfortably by using a compatible app. --The extension is ".md"

... apparently ...

As an example, the following is an example of the Rails application README.


users table

Column Type Options
user_name string null: false
email string null: false
password string null: false


As you can see, the README is indispensable for the application, and the description in it is Markdown notation, so it is necessary to learn Markdown notation at least.

Then, I will introduce an excerpt of what I often use.

――If you put "#" at the beginning and leave one half-width space, it will be the meaning of the heading and will be emphasized in capital letters. (Same meaning as h1 tag) "#" Is the largest, and as you increase it one by one, the capital letters become smaller and smaller, and you can write up to six "######" in a row.

――If you put "-" at the beginning and leave one half-width space, "・" will be added.

--You can create a horizontal line by inserting three or more "---" and "-" in a row.

The above was the description I often use. The above description method is really only a part, so if you are interested, I hope you can learn from a proper site. (Lol) Even so, all the people in Qiita post articles in Markdown notation, so I think that I'm probably the least familiar with (not mastering) Markdown notation among the people who posted to Qiita, so I will devote myself from now on. I would like to come. Thank you for staying with us so far.

Note: All "#" and "-" in Markdown notation will not be reflected correctly unless they are written in half-width characters. In addition, leave one half-width space. Please note that it will not be reflected in full-width characters!

The site that I referred to this time

[Artis Co., Ltd. Blog useful for business and IT utilization](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)

Recommended Posts

About Markdown notation
[Rails] About Slim notation
About =
About method.invoke
About attr_accessor
About Hinemos
About inheritance
About params
About Docker
About Rails 6
About Spring ③
DB design with markdown notation [55 days left]
About enum
About polymorphism
About Optional
About hashes
About Dockerfile
About this ()
About devise
About Docker
About active_hash
About static
About exceptions
About scope