반응형
Docusaurus Sidebar 제목에 prefix Icon 추가하기
업무 개선/문서화2024. 9. 14. 11:26Docusaurus Sidebar 제목에 prefix Icon 추가하기

Docusaurus 문서화를 하던 와중에 페이지의 직관성 및 가독성이 더 필요하다고 느끼게 되었습니다.그런 이유로 일부 기능을 더 보강하려고 합니다.그래서 가장 처음에 생각난 기능이 바로 Sidebar의 prefix에 icon을 추가해서 직관적으로 문서와 카테고리를 분류 하는 것입니다. 1. Custom CSS 추가 및 반영우선은 custom.css 파일을 적용하기 위해서아래와 같이 docusaurus.config.ts (혹은 js)에 custom.css 파일을 등록해 두어야합니다.presets: [ [ 'classic', { docs: { 중략... }, blog: { 중략... }, t..

Docusaurus를 활용한 Doc as a code 및 Github Pages로 Deploy 해보기
업무 개선/검토자료2024. 8. 4. 17:06Docusaurus를 활용한 Doc as a code 및 Github Pages로 Deploy 해보기

이전 포스트에서 우리 팀에서 원하는 기능에 대해서 동작하는지를 테스트 해보는 작업을 했습니다. Docusaurus를 사용한 Doc as a code Deploy 검토하기Doc as a code 요구사항Doc as a code Deploy를 위해서 요구사항을 기반으로 우리 부서에서 사용 가능한지 검토해보려고합니다.가장 최신버전인 Docusaurus v3.4.0를 기반으로 확인 해 보려고 합니다. 1. multi-ray5273.tistory.com 위의 테스트를 기반으로 실제 Deploy를 위한 작업을 했습니다.실제로 필요한 기능들을 사용 해 보면서 Github Pages로 Deploy할 수 있는 Template 코드를 작성했습니다. Tutorial Intro | Docusaurus TemplateLet's..

Docusaurus를 사용한 Doc as a code Deploy 검토하기
업무 개선/검토자료2024. 8. 3. 09:14Docusaurus를 사용한 Doc as a code Deploy 검토하기

Doc as a code 요구사항Doc as a code Deploy를 위해서 요구사항을 기반으로 우리 부서에서 사용 가능한지 검토해보려고합니다.가장 최신버전인 Docusaurus v3.4.0를 기반으로 확인 해 보려고 합니다. 1. multi-repository의 markdown 파일들에 대해서도 쉽게 indexing 제공각 폴더마다 _category_.json을 포함해야하는것으로 보입니다.{ "label": "Packer", "position": 2, "link": { "type": "generated-index", "description": "5 minutes to learn the most important Docusaurus concepts." }}이런 파일들을 추가하면 하위 ..

ADR 도입기 - (2) Doc as a code의 Deploy, user guide와 SRS 관리 방법 검토
업무 개선/문서화2024. 8. 3. 08:31ADR 도입기 - (2) Doc as a code의 Deploy, user guide와 SRS 관리 방법 검토

우리 부서에 맞는 ADR (Architecture Decision Record) 템플릿 작성과 ADR 시스템 도입현재 우리 부서 상황에 맞는 ADR 템플릿을 작성해 보려고 합니다.사실은 ADR이 무엇인지, ADR을 써야하는 이유는 무엇인지에 대해서 먼저 쓰고 싶었는데일단 부서내에서 ADR 사용에 대한 의견 제시ray5273.tistory.com  ADR 도입기 (1) - ADR 도입에 대한 팀원들의 의견과 피드백이전 포스트에서 부서 내에 ADR을 도입하려는 계획과 설득을 위한 문서를 작성했었습니다. 우리 부서에 맞는 ADR (Architecture Decision Record) 템플릿 작성과 ADR 시스템 도입현재 우리 부서 상황에 맞ray5273.tistory.com이전 포스트에 이어서 3번째 글입니다..

반응형
image