Skip to content

tsuji0422/Develop_DocsCode

Repository files navigation

Docs as Code ドキュメント(使い方ガイド)

このフォルダは「Markdown をベースに、1本のPDFにまとめる」ためのテンプレートです。初めて触る方向けに、編集と出力の手順だけに絞って案内します。

まずやること(3分)

  1. 表紙を編集する: cover.md
    • タイトル、バージョン、更新日、作成者、文書番号を入力
  2. 本文を編集する: chap01_xxx/, chap02_yyy/ 配下の .md
    • 各章の目次は chapXX/index.md にまとまっています
    • 画像は images/<節名>/ に置きます
  3. PDFにする: VS Code のタスク「Build PDF」を実行(index.pdf が生成)
    • 目次は index.md の「 … 」に自動生成されます

フォルダ構成(抜粋)

  • index.md … 全体の入口。各章を読み込みます(編集不要)
  • cover.md … 表紙(タイトルや承認欄など)
  • chap01_xxx/ … 第1章(各節ごとに .md ファイル)
  • chap02_yyy/ … 第2章(同上)
  • styles/print.css … PDFの見た目(文字サイズ、余白、図番号など)

編集ルール(最低限)

  • 節の最後は改ページしたい時に <div class="page-break"></div> を置きます

  • 図は次のように書くと図番号とキャプションが自動付与されます

    サンプル図 サンプル図の説明
  • 見出しの番号は自動で付きます(CSS)

    • h1: 「n章」
    • h2: 「n章 m節」
    • h3: 「n章 m節 k項」
    • 目次の見出しは自動で番号が付きません

章・節を追加したいとき

  • 第n章を増やす: chapNN_xxx/ フォルダを追加し、その中に index.md(章の導入)と各節の .md を作成
  • 章の読み込み: index.md@import "chapNN_xxx/index.md" を追加

PDFの見た目を少し変えたいとき

  • 余白や文字サイズは styles/print.css を編集
  • ヘッダー/フッター(ページ番号や日付)は index.md 先頭の設定(front-matter)を編集
    • 会社名や機密区分の文言を変える場合は headerTemplate/footerTemplate のHTMLを編集
    • 余白が重なる場合は pdf_options.margin を広げてください

より詳しい技術的な情報は README_AIAgent.md にまとめています。

GitHubでの基本的な進め方(ブランチ作成、PR、レビュー、タグ付けなど)は README_github.md を参照してください。

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors