markdown zen

마크다운젠

MarkdownZen은 마크다운 문서의 생성 및 관리를 간소화하도록 설계된 웹 애플리케이션입니다. 사용자 친화적인 인터페이스와 강력한 기능을 갖춘 MarkdownZen은 Zenful Markdown 경험을 위한 최고의 도구입니다.

목차

• 시작하기
  • 전제조건
  • 설치
• 용법
• 특징
• 도커로 실행하기
• 기여
• 특허

시작하기

전제조건

시작하기 전에 컴퓨터에 다음 소프트웨어가 설치되어 있는지 확인하십시오.

• Node.js
• npm(노드 패키지 관리자)

설치

1. 저장소를 복제하십시오 .

   터미널/명령 프롬프트를 열고 프로젝트를 저장하려는 위치로 이동합니다. 그런 다음 다음 명령을 실행하십시오.

git clone https://github.com/daniel752/markdown-zen.git

그러면 프로젝트 파일이 컴퓨터에 다운로드됩니다.

2. 프로젝트 폴더로 이동합니다 .

cd 명령을 사용하여 작업 디렉터리를 복제된 프로젝트 폴더로 변경합니다.

cd markdown-zen

3. 종속성 설치 :

프로젝트 폴더 내에서 단일 명령을 사용하여 서버와 클라이언트 모두에 필요한 종속성을 설치합니다.

npm run setup-project

그러면 앱의 서버 및 클라이언트 구성 요소에 필요한 패키지가 설치됩니다.

용법

1. 응용프로그램 시작 :

애플리케이션을 시작하려면 루트(markdown-zen/) 폴더에서 다음 명령을 실행합니다.

npm run dev

이 명령은 서버와 클라이언트를 동시에 시작하므로 브라우저에서 앱에 액세스할 수 있습니다.

2. 앱에 접속하세요 :

웹 브라우저를 열고 http://localhost:5173 으로 이동합니다. 여기에서 MarkdownZen 앱을 찾을 수 있습니다.

3. 마크다운 생성 및 관리 :

• 로그인하거나 계정을 만드세요.
• 손쉽게 마크다운 문서를 만들고 관리해 보세요.

특징

• 마크다운 문서를 쉽게 생성, 편집, 관리하세요.
• 편집하는 동안 실시간 마크다운 미리보기.
• 카테고리와 태그를 사용하여 마크다운을 구성합니다.
• 안전한 인증 및 승인 시스템.
• ...

도커로 실행하기

Docker를 사용하여 MarkdownZen을 실행할 수도 있습니다. 다음 단계를 따르세요.

1. Docker 이미지를 가져옵니다 .

   Docker Hub에서 MarkdownZen Docker 이미지를 가져옵니다.

   docker pull daniel752/markdown-zen:v1.0.0
   

2. 컨테이너 실행 :

   MarkdownZen 컨테이너를 시작합니다.

   docker run -d daniel752/markdown-zen:v1.0.0
   
   

• -d: 분리 모드(백그라운드)에서 컨테이너를 실행합니다.
• 컨테이너는 내부 포트 8000과 외부 5173을 실행합니다.

기여

우리는 커뮤니티의 기여를 환영합니다! MarkdownZen에 기여하려면 다음 단계를 따르세요.

1. 저장소 포크 :

GitHub 저장소 페이지 오른쪽 상단에 있는 "Fork" 버튼을 클릭하세요. 그러면 GitHub 계정 아래에 저장소 복사본이 생성됩니다.

2. 포크 복제 :

포크된 저장소를 로컬 머신에 복제합니다.

git clone https://github.com/your-username/markdown-zen.git

3. 새 지점 만들기 :

프로젝트 디렉터리로 변경합니다.

cd markdown-zen

기능에 대한 새 분기를 만듭니다.

git checkout -b feature/my-new-feature

4. 변경 :

필요한 사항을 변경하고 커밋합니다.

git commit -m 'Add some feature'

5. 변경사항 푸시 :

포크된 저장소에 변경 사항을 푸시합니다.

git push origin feature/my-new-feature

6. 끌어오기 요청 제출 :

GitHub의 원본 저장소를 방문하고 "New Pull Request" 버튼을 클릭하여 검토를 위해 변경 사항을 제출하세요.

특허

이 프로젝트는 MIT 라이선스에 따라 라이선스가 부여됩니다. 자세한 내용은 LICENSE 파일을 참조하세요.