나는 게으르다! 게으른가...?😴
문서 웹 사이트에 새 페이지를 추가하는 데 너무 많은 시간을 소비하고 있습니까? 그렇다면 여러분은 혼자가 아닙니다! 문서를 유지 관리하는 것은 파일 복사 및 붙여넣기, 마크다운 콘텐츠 작성 등 지루한 작업이 될 수 있습니다. 그래서 저는 간단한 마크다운 문서화 도구인 Rino Docs를 만들었습니다.
Rino Docs란 무엇인가요? 🤪
Rino Docs는 강력한 Rino.js를 이용하여 만들어진 간단한 마크다운 문서화 도구입니다. 새로운 문서 페이지를 추가하는 과정을 단순화하고 문서 웹 사이트의 디자인을 사용자 정의할 수 있습니다.
Rino Docs는 ./src/mds 디렉터리에서 마크다운 파일을 읽고 ./dist 디렉터리에 HTML 페이지를 생성합니다. 차별화되는 점은 모든 문서 페이지에 대한 링크 목록이 포함된 사이드바 구성 요소를 자동으로 생성하는 기능입니다. 더 이상 수동으로 링크를 더하지 마세요!
설치:
npm create rinodocs@latest
개발 및 빌드:
npm run dev
사이트맵 생성:
npm run sitemap
사이드바 링크 구성 🧐
사이드바의 링크들에 순서를 정하는 방법이 궁금할 것입니다. 아주 간단합니다! 마크다운 파일 이름 시작 부분에 숫자를 추가하기만 하면 됩니다. Rino Docs는 파일 이름의 숫자 순서에 따라 링크를 자동으로 정렬합니다. 예를 들어 파일 이름을 '1. 홈'을 선택하면 사이드바 상단에 배치됩니다.
문서 웹사이트 꾸미기 ✍️
문서 웹 사이트의 템플릿을 꾸미고 싶으십니까? Rino Docs는 유연하기 때문에 가능합니다! ./src/pages/ 및 ./src/comComponents/에 있는 파일을 편집하기만 하면 됩니다. 여러 언어를 지원해야 하거나 기타 조정이 필요한 경우 프로젝트 내의 모든 파일을 자유롭게 편집하세요!
마지막으로 🚀
문서화에 시간과 에너지를 너무 많이 쓰지 마세요. 지금 Rino Docs를 사용해 보고 문서 작업 흐름을 단순화해 보세요!
Top comments (0)