소프트웨어를 만들 때 가장 중요한 작업 중 하나는 문서화입니다. 안타깝게도이 작업을 개발하는 우리에게는 때때로 지루해 보이지만 좋은 문서화가 모든 도구의 성공 지점이 될 수 있다는 것은 누구에게도 비밀이 아닙니다. 애플리케이션의 올바른 작동을 이해하기 위해 사용자에게 제공되는 도움말 또는이를 개선하기 위해 다른 개발자에게 제공되는 정보.
간단한 방법으로 프로젝트를 문서화 할 수있는 아주 좋은 응용 프로그램이 있습니다. 프로젝트 문서화 도구 준수하고 사용 및 설치가 매우 간단한 것은 Docusaurus입니다.
Docusaurus는 무엇입니까?
도쿠사우루스 프로젝트입니다 오픈 소스 도구 웹 문서 구축, 구현 및 유지, 언어를 사용할 수 있습니다. 인하 나중에 html 웹 사이트로 게시 될 문서를 작성하기 위해 동일한 방식으로이 도구를 사용하여 React를 사용하여 문서 웹 사이트의 디자인을 확장하고 사용자 지정할 수 있습니다.
일반적으로 Facebook 프로그래밍 팀에서 개발 한이 오픈 소스 도구를 사용하면 모든 프로젝트의 문서를 적절하게 표시 할 수있는 아름답고 가벼운 웹 사이트를 쉽게 만들 수 있습니다.
이 도구는 문서의 올바른 버전 관리, 고급 검색 엔진, 문서 사이트를 실시간으로 문서화하고 재 설계 할 수있는 기능, 번역과의 통합 및 문서 작성에 대한 걱정을 덜어 주거나 작성하는 데 도움이되는 기타 많은 기능을 갖추고 있습니다. 문서화 프로세스가 더 쉽고 유쾌하게 마무리됩니다.
Docusaurus의 쉬운 사용은 개발자가 배포 한 다음 gif에서 볼 수 있습니다.
Docusaurus를 설치하는 방법?
Docusaurus의 주요 목표는 github에서 호스팅되는 오픈 소스 애플리케이션을 문서화하기위한 결정적인 도구가되는 것이므로이 플랫폼에서 문서 웹 사이트를 설치하고 실행하는 것이 정말 쉽습니다.
Github에서 Docusaurus를 즐기려면 개발 팀이 지시 한 단계를 따르고 아래에서 인용합니다.
- 문서를 생성 할 GitHub 저장소 디렉토리의 루트로 이동하고 다음 명령을 실행합니다.
yarn global add docusaurus-initornpm install --global docusaurus-initdocusaurus-init
최종 결과는 아래와 같이 파일 및 디렉토리 구조가 생성됩니다.
시도 할 흥미로운 버그!