프로젝트 소개

docx는 .docx(Microsoft Word) 문서를 생성하고 수정하기 위한 오픈소스 JavaScript/TypeScript 라이브러리입니다. README는 선언적 API를 제시합니다. 즉 Document, Paragraph, Header, Table 같은 객체로 문서 구조를 기술하면 라이브러리가 .docx 파일을 생성합니다. Node와 브라우저 모두에서 동작한다고 명시되어 있습니다. 문서와 예제는 docx.js.org에 있으며, 저장소에는 demo 폴더가 포함되어 있습니다. README는 CodePen과 JSFiddle의 브라우저 데모, StackBlitz의 Angular, React, Vue.js 프레임워크 예제, 그리고 간단한 문단과 고급 문단, 글머리 기호, 표, 이미지, 여백, 가로 방향, 머리글과 바닥글을 다루는 RunKit의 Node 예제로 연결됩니다. 한 예제는 docx로 생성한 CV라고 설명되어 있습니다. 핵심 패키지 외에도 README는 선택적 진입점을 문서화합니다. docx/shapes는 도형, 도형 그룹, 커넥터가 있는 다이어그램용이고, docx/watermarks는 워터마크용이며, docx/charts는 네이티브 Word 차트용입니다. 이들은 메인 패키지에서 제외되어 이를 사용하지 않는 문서에는 해당 코드가 포함되지 않습니다. 한 코드 샘플은 ChartRun, ShapeRun, TextWatermark를 가져와 섹션, 머리글, 문단이 있는 Document 안에서 사용하는 모습을 보여줍니다. 번들러가 없는 페이지의 경우 README는 dist/index.umd.cjs 뒤에 dist/shapes.umd.cjs, dist/watermarks.umd.cjs 또는 dist/charts.umd.cjs를 로드하여 docxShapes, docxWatermarks, docxCharts 전역을 추가하라고 안내합니다. README는 또한 실시간으로 코드를 작성하고 결과를 미리 볼 수 있는 대화형 플레이그라운드인 Docx.js Editor와 기여 지침을 가리킵니다. 이 라이브러리의 사용자로 여러 회사와 제품을 나열하고, npm 버전, 월간 다운로드, GitHub Actions 워크플로 상태, 알려진 취약점, 풀 리퀘스트 환영 상태, 코드 커버리지 배지를 포함합니다. 이 프로젝트는 npm을 통해 docx라는 패키지 이름으로 배포됩니다.