このプロジェクトについて
docxは、.docx(Microsoft Word)ドキュメントを作成および変更するためのオープンソースのJavaScript/TypeScriptライブラリです。READMEには宣言的APIが示されています。Document、Paragraph、Header、Tableなどのオブジェクトでドキュメント構造を記述すると、ライブラリが.docxファイルを生成します。Nodeとブラウザの両方で動作すると記載されています。
ドキュメントと例はdocx.js.orgにあり、リポジトリにはデモフォルダが含まれています。READMEには、CodePenとJSFiddleのブラウザデモ、Angular、React、Vue.js用のフレームワーク例(StackBlitz)、単純および高度な段落、箇条書き、表、画像、余白、横向き、ヘッダーとフッターをカバーするNodeの例(RunKit)へのリンクがあります。1つの例は、docxで生成されたCVとして説明されています。
コアパッケージに加えて、READMEはオプションのエントリポイントを文書化しています。docx/shapes(図形、図形グループ、コネクタ付きダイアグラム)、docx/watermarks(透かし)、docx/charts(ネイティブWordチャート)です。これらはメインパッケージから分離されており、使用しないドキュメントにはコードが含まれません。コードサンプルでは、ChartRun、ShapeRun、TextWatermarkをインポートし、セクション、ヘッダー、段落を含むDocument内で使用する方法が示されています。バンドラーを使用しないページでは、dist/index.umd.cjsの後にdist/shapes.umd.cjs、dist/watermarks.umd.cjs、またはdist/charts.umd.cjsをロードすると、docxShapes、docxWatermarks、docxChartsのグローバルが追加されるとREADMEに記載されています。
READMEはまた、コード作成と結果のリアルタイムプレビューが可能なインタラクティブなプレイグラウンドであるDocx.js Editorと、貢献ガイドラインを指摘しています。ライブラリのユーザーとして多数の企業と製品をリストし、npmバージョン、月間ダウンロード数、GitHub Actionsワークフローステータス、既知の脆弱性、プルリクエスト歓迎ステータス、コードカバレッジのバッジを含んでいます。プロジェクトはnpmでパッケージ名docxとして配布されています。
Comments
0 people shared their preference · Deer Point appears after 10 participants
Sign in to join the discussion.