Docusaurus로 여러 문서 만들기

Docusaurus은 Facebook에서 개발하고 react를 기반으로 하는 오픈 소스 프레임워크입니다. 매우 작은 구성으로 깨끗하고 버전이 가능한 다국어 문서를 만들 수 있습니다.

프로젝트 만들기

다음 명령을 사용하여 프로젝트를 초기화합니다.

npx @docusaurus/init@latest init my-website classic --typescript

그런 다음 개발 모드를 시작할 수 있습니다.

cd my-websiteyarn start

프로젝트 구조

Jekyll과 동일한 철학으로 마크다운 파일을 기반으로 정적 사이트를 생성할 수 있지만 jsx에서 직접 페이지를 생성할 수도 있습니다.

Docs file The docs file contains all the chapters of your documentation. We will see how to configure it to have two distinct documentations.

두 번째 문서 만들기

도큐사우르스 구성

하나는 Guide이고 다른 하나는 Api입니다. navbar 구성에 항목을 추가합니다.

navbar: {
 {
  type: 'doc',
  docId: 'guide/intro',
  position: 'left',
  label: 'Docs',
 },
 {
  type: 'doc',
  docId: 'api/intro',
  position: 'left',
  label: 'Api',
 },
}

사이드바

두 개의 설명서를 포함하도록 사이드바를 수정하고 dirName 폴더에 생성할 하위 폴더로 해당 docs를 설정합니다.

module.exports = {
    docSidebar: [{ type: 'autogenerated', dirName: 'guide' }],
    apiSidebar: [{ type: 'autogenerated', dirName: 'api' }],
};

문서 작성

이제 두 개의 문서를 만들 수 있는 두 개의 폴더docs/guide 및 docs/api를 만들어야 합니다.