Ghi chú với Markdown và GitHub

Cách tôi tạo một kho lưu trữ đơn giản để ghi chú bằng Markdown và GitHub.

Tôi hiểu rồi, bạn phát ngán với hàng nghìn video trên YouTube và các bài đăng trên blog về việc ghi chú. Tôi cũng vậy! Vì vậy, tôi quyết định bắt đầu cuộc rượt đuổi và xây dựng hệ thống ghi chú không cần BS của riêng mình, đơn giản nhất có thể.

Khái niệm ? Vâng, trông thật tuyệt vời nhưng tôi không có thời gian để leo lên con đường học tập dốc đứng đó.

Về cơ bản, bất kỳ ứng dụng di động nào để ghi chú? Có thể, nhưng tôi muốn có thể nhanh chóng tìm kiếm thông tin khi đang làm việc, giảm thiểu chuyển đổi ngữ cảnh và hy vọng giữ tay trên bàn phím khi đang làm việc.

Một tập tin văn bản đơn giản? Có thể hơi quá, vâng, nó đơn giản và không cần bảo trì, nhưng tôi muốn các ghi chú của mình có thể đọc được, và mặt khác, tôi không muốn lãng phí thời gian để định dạng những gì mình viết… vậy, ai có thể cứu tôi bây giờ?

Nhập Markdown . Dễ viết, mất rất ít thời gian để làm quen với cú pháp và kết quả cuối cùng là hơn cả chấp nhận được!

Bây giờ hãy hình dung tình huống này: bạn đang duyệt qua một cơ sở mã lớn trong trình soạn thảo văn bản mà bạn chọn, và bạn bắt gặp một hàm hoặc cách sử dụng phương thức và bạn muốn xem lại cách triển khai của nó. Điều tôi thường làm trong trường hợp này là khởi chạy tìm kiếm toàn dự án trên Mã VS và tôi nhận được kết quả ngay lập tức. Vậy tại sao chúng ta không kết hợp những điều tốt nhất của cả hai thế giới?

Markdown và VS Code cùng nhau cung cấp giải pháp cho hai vấn đề lớn nhất của tôi với bất kỳ hệ thống ghi chú nào: dễ dàng viết các ghi chú có thể đọc được với nỗ lực định dạng tối thiểu và khả năng truy vấn thông tin bất cứ khi nào tôi muốn .

Vì vậy, làm thế nào để bạn xây dựng nó? Thật dễ dàng như việc tạo một kho lưu trữ trống trong GitHub, sau đó kích hoạt Visual Studio Code cho Web .

Khi bạn ở trong đó, hãy nhấp vào “Mở thư mục” và Mã VS sẽ nói rằng việc mở các thư mục cục bộ không được hỗ trợ và thay vào đó sẽ cho phép bạn mở một thư mục từ xa. Bằng cách đăng nhập bằng tài khoản GitHub của bạn, bạn sẽ có thể mở bất kỳ kho lưu trữ nào bạn muốn.

Tôi thích cấu trúc các ghi chú của mình theo cách sau:

- <Project Name>
  - Useful Commands
  - Research
  - Tasks

Bên trong mỗi thư mục dự án, Lệnh hữu ích lưu trữ một tệp đánh dấu duy nhất với các lệnh hữu ích cho các tác vụ như khởi động bộ chứa Docker, chạy thử nghiệm, v.v.

Nghiên cứu lưu giữ các ghi chú nghiên cứu cho các chủ đề khác nhau, mục tiêu chính ở đây là cố gắng giải thích các khái niệm cho chính tôi như thể tôi đang giải thích nó cho người khác.

Nhiệm vụ là nhiệm vụ mà tôi tin rằng đã tạo ra tác động lớn nhất đến năng suất của tôi. Tại đây, tôi đặt một tệp Markdown cho mỗi vé Jira mà tôi được chỉ định và tôi cố gắng làm theo mẫu sau:

# JIRA_ID - Ticket name
Short description of the task. 
If the task doesn't have an acceptance criteria it is a good exercise 
to read the description a few times and write it down yourself.

In here I leave a space for pasting useful material, like code snippets,
links, YouTube videos, anything that might help me answer whatever
questions arise.

## Steps To Succeed
Step by step definition, with clear action items to achieve a solution.
Include possible alternate paths, and every thought that helps you implement
your idea.

Đó là nó cho cái này, nếu bạn đã đến cuối bài này, cảm ơn bạn rất nhiều và chúc một ngày tốt lành! :)