거, 리드미(README) 좀 쉽게 쓰는 방법 없소?

원아·2021년 10월 20일
67

프로젝트

목록 보기
1/2
post-thumbnail

EASYME.md

팀 프로젝트를 진행하면서 최종적으로 리드미(READMD.md)를 작성할 때 겪었던 불편함이 있었다. 리드미에 어떤 내용을 담느냐에 대한 고민은 둘째 치더라도 마크다운 문법을 자주 사용하는 것이 아니니.. 그때그때 찾아서 쓰고 여간 비효율적인 게 아니었다.

아, 이런 불편함. 이거 개인 프로젝트 때 녹여보면 어떨까. 그래서 탄생한 게 이지미(EASYME.md)다.

EASYME.md

이지미는 마크다운 문법을 쉽게 적용하여 개발자들이 조금 더 편리하고 빠르게 리드미를 작성할 수 있도록 도와준다.

왼쪽 화면은 글을 작성하는 공간이고, 오른쪽 화면은 작성한 글에 따라 마크다운 문법이 적용되어 보여진다.

마크다운 문법을 잘 모른다고? 괜찮다. 그래서 만든 거다.

EASYME.md

위 이미지처럼 왼쪽 화면에 글을 작성하고 내가 스타일을 적용하고 싶은 부분을 드래그 한 다음 위 Bold 기능을 적용하면, 자동으로 마크다운 문법이 적용되는 식이다.

EASYME.md

짜잔. 이렇게 오른쪽 화면에 마크다운 문법이 적용되어 보인다.

그외에도 다양한 기능이 있는데 조금 설명하자면..

  • 인용문
  • 접고 펴기
  • 대소문자
  • 목차
  • 리스트
  • 스크린 모드(왼쪽 화면만, 오른쪽 화면만, 풀 스크린)
  • 공유하기(저장하기) 등...

이런 것들이 있다.

특히 공유하기(저장하기) 기능은 툴바 제일 오른쪽에 아이콘을 누르면 링크가 생성되어 내가 작성한 글을 다른 사람에게 공유할 수 있다. 단축키 Ctrl + S(Command + S) 로도 저장할 수 있다.

이상 이지미의 소개는 여기서 끝으로 하고 앞으로 계속해서 개선을 할 예정이다. 혹시나 쓰면서 불편한 점이 있거나 피드백 있으면 언제든 환영! (많이 좀 써달라는 얘기입니다..)

(PS. 저 이제 취업 준비해요..)

Hits

profile
당근마켓 마케터로 2년 7개월 끝에 졸업. 개발자 시작.

14개의 댓글

comment-user-thumbnail
2021년 10월 24일

4컷 만화보고 조금 킹받았지만... 취준 열심히 하셔요!!

1개의 답글
comment-user-thumbnail
2021년 10월 24일

와... 아이디어 좋은데요?

1개의 답글
comment-user-thumbnail
2021년 10월 25일

markdown을 입문하는 사람에게 좋은 것 같습니다
다만 TOC(목차) 생성이 작성된 문서를 기준인가 기대했지만... 예시만 추가하는 기능이더라구요ㅠ
그래도 굿굿👍

1개의 답글
comment-user-thumbnail
2021년 10월 27일

감사합니다 초보자인 저한텐 엄청 도움됩니다 ㅠㅠ

1개의 답글
comment-user-thumbnail
2021년 10월 28일

와우 ㅋㅋ 감사합니다 좋은툴!!

1개의 답글
comment-user-thumbnail
2021년 10월 28일

(주섬주섬...)

1개의 답글
comment-user-thumbnail
2021년 10월 30일

너무 좋네요
혹시 동영상 을 read me에서 바로 실행할 수 있도록 할 수는 없을까요?
계속 찾고있는데 링크 첨부외에는 바로 실행하는 방법은 보이지 않네요 ㅠ

1개의 답글