Markdown 및 GitHub를 사용한 메모 작성

Markdown 및 GitHub를 사용하여 메모를 작성하기 위한 간단한 저장소를 만든 방법.

알겠습니다. 메모 작성에 관한 수천 개의 YouTube 동영상과 블로그 게시물에 질리셨을 것입니다. 나도 그래! 그래서 나는 추격을 중단하고 가능한 한 간단하고 BS가 아닌 메모 작성 시스템을 구축하기로 결정했습니다.

개념 ? 예, 멋져 보이지만 가파른 학습 곡선을 올라갈 시간이 없습니다.

기본적으로 메모를 위한 모바일 앱이 있습니까? 그럴 수도 있지만 작업하는 동안 정보를 빠르게 검색하고 컨텍스트 전환을 최소화하고 작업하는 동안 키보드 위에 손을 올려놓고 싶습니다.

일반 텍스트 파일? 어쩌면 너무 극단적일 수도 있습니다. 예, 간단하고 유지 관리가 필요하지 않지만 메모를 읽을 수 있기를 원하고 다른 한편으로는 내가 작성한 서식을 지정하는 데 시간을 낭비하고 싶지 않습니다. 그렇다면 누가 나를 구할 수 있습니까?

마크다운을 입력합니다 . 작성하기 쉽고 구문에 익숙해지는 데 시간이 거의 걸리지 않으며 최종 결과는 수용 가능합니다!

이제 이 상황을 상상해 보십시오. 선택한 텍스트 편집기에서 큰 코드베이스를 탐색하고 함수 또는 메서드 사용을 실행하고 해당 구현을 다시 방문하려고 합니다. 이 경우 일반적으로 하는 일은 VS Code에서 프로젝트 전체 검색을 시작하는 것이며 즉각적인 결과를 얻습니다. 그렇다면 두 세계의 장점을 함께 가져오지 않겠습니까?

Markdown과 VS Code는 메모 작성 시스템의 두 가지 가장 큰 문제인 최소한의 서식 작업으로 쉽게 읽을 수 있는 메모 작성 과 원할 때마다 정보를 쿼리할 수 있는 기능에 대한 솔루션을 제공합니다 .

어떻게 구축합니까? GitHub에서 빈 리포지토리를 만든 다음 Visual Studio Code for the Web을 실행하는 것만큼 쉽습니다 .

일단 거기에 있으면 "폴더 열기"를 클릭하면 VS Code는 로컬 폴더 열기가 지원되지 않는다고 말하고 대신 원격 폴더를 열 수 있도록 합니다. GitHub 계정으로 로그인하면 원하는 리포지토리를 열 수 있습니다.

나는 다음과 같은 방식으로 노트를 구성하는 것을 좋아합니다.

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

모든 프로젝트 폴더 내에서 Useful Commands는 Docker 컨테이너 시작, 테스트 실행 등과 같은 작업에 유용한 명령이 포함된 단일 마크다운 파일을 호스팅합니다.

연구는 다양한 주제에 대한 연구 노트를 보유하고 있으며, 여기서 주요 목표는 마치 다른 사람을 위해 설명하는 것처럼 나 자신에게 개념을 설명하려고 시도하는 것입니다.

작업 은 내 생산성에 가장 큰 영향을 미쳤다고 생각합니다. 여기에 할당된 모든 Jira 티켓에 대한 Markdown 파일을 배치하고 이 템플릿을 따르려고 합니다.

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

여기까지입니다. 이 게시물의 맨 아래에 도달했다면 정말 감사하고 좋은 하루 보내세요! :)