Mencatat dengan Markdown dan GitHub

Bagaimana saya membuat repositori sederhana untuk mencatat menggunakan Markdown dan GitHub.

Saya mengerti, Anda muak dengan ribuan video YouTube dan posting blog tentang membuat catatan. Aku juga! Jadi saya memutuskan untuk langsung mengejar, dan membuat sendiri, sesederhana mungkin, sistem pencatatan tanpa BS.

Gagasan ? Ya, terlihat luar biasa tetapi saya tidak punya waktu untuk mendaki kurva belajar yang curam itu.

Pada dasarnya ada aplikasi seluler untuk mencatat? Bisa jadi, tetapi saya ingin dapat mencari informasi dengan cepat saat saya sedang bekerja, meminimalkan peralihan konteks, dan mudah-mudahan tetap menggunakan keyboard saat melakukannya.

File teks biasa? Mungkin agak terlalu ekstrim, ya sederhana dan tidak memerlukan perawatan, tetapi saya ingin catatan saya dapat dibaca, dan di sisi lain saya tidak ingin membuang waktu untuk memformat apa yang saya tulis… jadi, siapa yang dapat menyelamatkan saya sekarang?

Masukkan penurunan harga . Mudah untuk menulis, membutuhkan sedikit waktu untuk membiasakan diri dengan sintaks, dan hasil akhirnya lebih dari cukup!

Sekarang bayangkan situasi ini: Anda menjelajahi basis kode besar di editor teks pilihan Anda, dan Anda menemukan fungsi atau penggunaan metode, dan Anda ingin meninjau kembali penerapannya. Apa yang biasanya saya lakukan dalam kasus ini adalah meluncurkan pencarian di seluruh proyek di VS Code, dan saya mendapatkan hasil instan. Jadi mengapa kita tidak menyatukan yang terbaik dari kedua dunia?

Markdown dan VS Code bersama-sama memberikan solusi untuk dua masalah terbesar saya dengan sistem pencatatan apa pun: mudah menulis catatan yang dapat dibaca dengan upaya pemformatan minimum , dan kemampuan untuk menanyakan informasi kapan pun saya mau .

Jadi, bagaimana Anda membangunnya? Semudah membuat repositori kosong di GitHub, lalu menjalankan Visual Studio Code for the Web .

Setelah Anda berada di sana, klik "Buka Folder", dan VS Code akan mengatakan bahwa membuka folder lokal tidak didukung, dan sebagai gantinya akan membiarkan Anda membuka folder jarak jauh. Dengan masuk menggunakan akun GitHub Anda, Anda akan dapat membuka repositori apa pun yang Anda inginkan.

Saya suka menyusun catatan saya dengan cara berikut:

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

Di dalam setiap folder proyek, Perintah Berguna menghosting satu file penurunan harga dengan perintah berguna untuk tugas seperti memulai wadah Docker, menjalankan pengujian, dan sebagainya.

Penelitian menyimpan catatan penelitian untuk topik yang berbeda, tujuan utamanya di sini adalah untuk mencoba dan menjelaskan konsep kepada diri saya sendiri seolah-olah saya sedang menjelaskannya untuk orang lain.

Tugas adalah hal yang saya yakini telah memberikan dampak terbesar dalam produktivitas saya. Di sini saya menempatkan file Markdown untuk setiap tiket Jira yang saya dapatkan, dan saya mencoba mengikuti template ini:

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

Itu saja untuk yang satu ini, jika Anda berhasil sampai ke bagian bawah posting ini, terima kasih banyak dan semoga harimu menyenangkan! :)