จดบันทึกด้วย Markdown และ GitHub

Mar 07 2023
ฉันสร้างที่เก็บอย่างง่ายสำหรับการจดบันทึกโดยใช้ Markdown และ GitHub ได้อย่างไร ฉันเข้าใจแล้ว คุณเบื่อวิดีโอ YouTube และบล็อกโพสต์นับพันเกี่ยวกับการจดบันทึก

ฉันสร้างที่เก็บอย่างง่ายสำหรับการจดบันทึกโดยใช้ Markdown และ GitHub ได้อย่างไร

ภาพถ่ายโดย Karolina Grabowska: https://www.pexels.com/photo/crop-man-with-pen-and-opened-notebook-4195401/

ฉันเข้าใจแล้ว คุณเบื่อวิดีโอ YouTube และบล็อกโพสต์นับพันเกี่ยวกับการจดบันทึก ฉันก็เช่นกัน! ดังนั้นฉันจึงตัดสินใจที่จะตัดการไล่ล่าและสร้างระบบจดบันทึกแบบไม่มี BS ที่เรียบง่ายที่สุดเท่าที่จะเป็นไปได้

ความคิด ? ใช่ ดูน่าทึ่ง แต่ฉันไม่มีเวลาปีนขึ้นไปบนเส้นโค้งแห่งการเรียนรู้ที่สูงชันขนาดนั้น

โดยทั่วไปมีแอพมือถือสำหรับจดบันทึกหรือไม่? อาจเป็นได้ แต่ฉันต้องการที่จะสามารถค้นหาข้อมูลได้อย่างรวดเร็วในขณะที่ฉันทำงาน ลดการสลับบริบท และหวังว่าฉันจะวางมือบนแป้นพิมพ์ในขณะที่ฉันกำลังทำอยู่

ไฟล์ข้อความธรรมดา? อาจจะสุดโต่งไปหน่อย ใช่ มันเรียบง่ายและไม่ต้องการการบำรุงรักษา แต่ฉันต้องการให้บันทึกของฉันอ่านได้ และในทางกลับกัน ฉันไม่ต้องการเสียเวลาในการจัดรูปแบบสิ่งที่ฉันเขียน… ดังนั้น ใครจะช่วยฉันได้ในตอนนี้

ป้อนMarkdown _ เขียนง่าย ใช้เวลาน้อยมากในการทำความคุ้นเคยกับไวยากรณ์ และผลลัพธ์ที่ได้ก็เกินจะรับได้!

ตอนนี้ลองนึกภาพสถานการณ์นี้:คุณกำลังเรียกดูโค้ดเบสขนาดใหญ่ในโปรแกรมแก้ไขข้อความที่คุณเลือก และคุณพบฟังก์ชันหรือวิธีการใช้ และคุณต้องการกลับมาใช้งานอีกครั้ง สิ่งที่ฉันมักจะทำในกรณีนี้คือเปิดการค้นหาทั่วทั้งโครงการบน VS Code และฉันได้รับผลลัพธ์ในทันที แล้วทำไมเราไม่นำสิ่งที่ดีที่สุดของทั้งสองโลกมารวมกันล่ะ?

Markdown และ VS Code ร่วมกันมอบวิธีแก้ปัญหาสำหรับสองปัญหาใหญ่ที่สุดของฉันกับระบบการจดบันทึก: การเขียนบันทึกย่อที่อ่านได้ง่ายด้วยความพยายามในการจัดรูปแบบขั้นต่ำและ ความสามารถในการสืบค้นข้อมูลเมื่อใดก็ตามที่ ฉันต้องการ

แล้วคุณจะสร้างมันขึ้นมาได้อย่างไร? มันง่ายพอๆ กับการสร้างพื้นที่เก็บข้อมูลว่างใน GitHub จากนั้นเริ่มการทำงานของVisual Studio Code สำหรับเว็บ

รหัส VS สำหรับเว็บ

เมื่อคุณเข้าไปแล้ว ให้คลิก “เปิดโฟลเดอร์” และ VS Code จะแจ้งว่าไม่รองรับการเปิดโฟลเดอร์ในเครื่อง และจะให้คุณเปิดโฟลเดอร์ระยะไกลแทน เมื่อเข้าสู่ระบบด้วยบัญชี GitHub คุณจะสามารถเปิดพื้นที่เก็บข้อมูลที่คุณต้องการได้

ฉันชอบจัดโครงสร้างโน้ตด้วยวิธีต่อไปนี้:

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

ภายในโฟลเดอร์โปรเจ็กต์ทุกโฟลเดอร์Useful Commandsจะโฮสต์ไฟล์มาร์กดาวน์หนึ่งไฟล์พร้อมคำสั่งที่มีประโยชน์สำหรับงานต่างๆ เช่น การเริ่มคอนเทนเนอร์ Docker การรันการทดสอบ และอื่นๆ

การวิจัยมีบันทึกการวิจัยสำหรับหัวข้อต่างๆ เป้าหมายหลักที่นี่คือการพยายามอธิบายแนวคิดให้กับตัวเองราวกับว่าฉันกำลังอธิบายให้คนอื่นฟัง

งานเป็นสิ่งที่ผมเชื่อว่ามีผลกระทบมากที่สุดในประสิทธิภาพการทำงานของฉัน ที่นี่ฉันวางไฟล์ Markdown สำหรับตั๋ว Jira ทุกใบที่ฉันได้รับมอบหมาย และฉันพยายามทำตามเทมเพลตนี้:

# 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.


เพียงเท่านี้ หากคุณมาถึงด้านล่างของโพสต์นี้ ขอบคุณมากและขอให้มีความสุขในวันนี้! :)