작성

1. MkDocs 설정 파일 수정

MkDocs의 설정 파일인 mkdocs.yml을 수정하여 사이트 구성 가능

1. 편집기를 이용하여 프로젝트 디렉터리의 mkdocs.yml 파일 오픈

2. 구성 예시

site_name: KCT Manual
nav:
  - Home: index.md
  - User Guide:
      - Introduction: guide/introduction.md      
      - EtherCAT: guide/ethercat.md      
      - Object Dictionary: guide/dictionary.md
theme:
  name: readthedocs

• 개발 서버가 열려 있다면 변경 사항 즉시 확인 가능

6. 문서 작성

docs 폴더 내의 Markdown 파일을 수정하거나 새로운 파일을 추가하여 문서 작성

1. docs/index.md 파일을 텍스트 편집기로 열어 내용 수정

2. 새 문서를 추가하려면 docs 폴더에 새로운 Markdown 파일 생성
   • 폴더 구조인 경우, 폴더 생성 후 파일 생성

> echo "# Introduction" > docs/guide/introduction.md

7. 사이트 배포

문서를 모두 작성한 후 정적 사이트를 생성하여 배포

1. 다음 명령어를 입력하여 정적 사이트 파일 생성

> mkdocs build

2. site 폴더 및 정적 파일 생성 확인

3. 이 파일들을 웹 서버에 업로드하거나 GitHub Pages 등을 통해 배포

Buy me a coffee