• 1. Readme là gì

• 2. Các thành phần của readme

  • 2.1 Ký tự # - ký tự header

  • 2.2 Tạo contents

  • 2.3 Trích xuất thông tin

  • 2.4 Link

  • 2.5 Xuống dòng, khoảng trống

  • 2.6 Giả lập code

  • 2.7 In nghiêng, in đậm

  • 2.8 Gạch đầu dòng

  • 2.9 Tạo bảng

• Tham khảo

  • Dùng Raw để phân tích readme

  • Tham khảo thêm

Readme.md là một file hiển thị thông tin trên github, được viết dưới dạng ngôn ngữ thiết kế ( markup language), tương tự HTML, XML,...

Chúng ta có thể thấy hầu hết các project ở trên github thường có một file readme đi kèm, vậy tại sao người lập trình cần tạo ra file readme, nếu không tạo thì có được không? Khi chúng ta vào xem code của một người khác trên github file đầu tiên hiển thị trước mắt chúng ta đó chính là file readme. Nó giống như một cái thực đơn (menu) của nhà hàng, khi chúng ta nhìn vào một cái menu nhà hàng thì chúng ta có thể phần nào đó đoán được nhà hàng đó bán những loại thức ăn gì, nước uống gì, giá cả ra sao. File readme cũng có nhiều phần tương tự như vậy.

Vậy các lợi ích của file README là gì?

1. Đầu tiên là thông tin về dự án (project) của các bạn, file readme sẽ chỉ ra một cách tổng quan cho các bạn biết dự án này đang làm về vấn đề gì, code web, android, hay AI... hay chỉ đơn giản là code một bài toán nhỏ.

2. Hướng dẫn người khác sử dụng code của project, khi các bạn vào các trang githup của express hay mongodb, ... để học tập một công nghệ mới, hoặc muốn sửa code của họ nếu như bạn thấy mình đủ trình. Khi bạn lên code của một cái game trên github sau đó bạn tải về, nhưng không biết cách sử dụng, thì file readme sẽ là một cái hướng dẫn sử dụng tuyệt vời cho bạn đấy.

Trong phần này mình sẽ tập trung các thành phần của Readme và hướng dẫn các bạn sử dụng file readme để viết một file readme thật tuyệt vời.

Chúng ta sẽ có 6 header tương ứng vơi mỗi dấu #, ví dụ # sẽ là head1, ### sẽ là header3. Nó sẽ trông như này:

Code:

# header H1 
## header H2 
### header H3 
#### header H4 
##### header H5 
##### header H6 

Lưu ý là dấu # phải ở đầu dòng và có cách ra một khoảng trắng nhỏ với dấu # nhá.

Để tạo bảng được các bạn sử dụng * để khai báo một dòng.

Sử dụng [tagname] để link đến tab bên dưới.

• Trích xuất thông tin
• Link ảnh
• Tham khảo

Code:

#### Table of contents
* [Trích xuất thông tin](#23-trích-xuất-thông-tin)
* [Link ảnh](#24-link)
* [Tham khảo](https://facebook.com)

Để trích xuất thông tin, hay nói cách khác là hiển thị nó ở một block đặc biệt ta có thể sử dụng ký tự `,``, ```

To run this project, install it locally using npm:

$ cd ../lorem
$ npm install
$ npm start

Để link đến một trang web chúng ta có thể dùng (link)

Link sẽ được chia làm hai loại: link nội bộ #24-link- đây là link dùng trong file readme và link ngoại bộ http://www.facebook.com - link url đầy đủ đến một trang web

Link và https://www.facebook.com

node Code: [node](http://nodejs.org).

Để hiện thị một ảnh lên file readme thì điều đầu tiên là chúng ta cần upload ảnh lên github...

Sau đó dùng ![ name ] (link) để link đến một ảnh

Code: ![tekst alternatywny](ścieżka/do/pliku)

Code: [![Express Logo](https://i.cloudup.com/zfY6lL7eFa-3000x3000.png)](http://expressjs.com/)

dòng 1 dòng 2

dòng 1

dòng 2

            Git point – exemplary Android application. A table of content makes navigation easier, the screenshots, mentioned functionalities, and information how to support application's development

<!-- The core Firebase JS SDK is always required and must be listed first -->
<script src="https://www.gstatic.com/firebasejs/8.2.1/firebase-app.js"></script>

<!-- TODO: Add SDKs for Firebase products that you want to use
     https://firebase.google.com/docs/web/setup#available-libraries -->
<script src="https://www.gstatic.com/firebasejs/8.2.1/firebase-analytics.js"></script>

<script>
  // Your web app's Firebase configuration
  // For Firebase JS SDK v7.20.0 and later, measurementId is optional
  var firebaseConfig = {
    apiKey: "AIzaSyCcsPYXVPBwv9cjgMqfkLAxkeSxmP6FmWk",
    authDomain: "my-first-project---web.firebaseapp.com",
    projectId: "my-first-project---web",
    storageBucket: "my-first-project---web.appspot.com",
    messagingSenderId: "26224504521",
    appId: "1:26224504521:web:e8a336c4820f307e276718",
    measurementId: "G-Y91P3HZGRZ"
  };
  // Initialize Firebase
  firebase.initializeApp(firebaseConfig);
  firebase.analytics();
</script>

$ express /tmp/foo && cd /tmp/foo

từ cần in đậm từ cần in nghiêng

• Gạch đầu dòng thứ nhất

  • Thụt với đầu dòng 1

  • Thụt với đầu dòng 1

• Gạch đầu dòng thứ hai

  • Thụt với đầu dòng 2

  • Thụt với đầu dòng 2

https://markdownlivepreview.com/

https://github.com/hocchudong/git-github-for-sysadmin/blob/master/README.md