マニュアル

StitchSketchEx ユーザーマニュアル

Astro 上でスクリーンショット中心のマニュアルを構成するためのサンプルです。

StitchSketchEx ユーザーマニュアル

このサンプルは、スクリーンショットが多いオンラインマニュアルを Astro と MDX で構成するための最小単位です。

StitchSketchEx overview

このマニュアルで確認できること

  • /ja/manuals/stitchsketchex-users-manual/ というマニュアル単位の URL
  • frontmatter から生成される左サイドバー
  • 章ページと子ページを持つツリー構造
  • 既存サイトに無理なく載せられるスクリーンショット中心の MDX ページ

はじめに

  1. はじめに を開きます。
  2. 次に 図案を新規作成する を確認します。

スクリーンショット

このサンプルでは既存画像を再利用しています。運用時は src/assets/manuals/stitchsketchex-users-manual/ja/ のような専用ディレクトリへ移すと整理しやすくなります。

Manual screenshot sample

1 冊のマニュアルごとに overview ページを持たせると、導入説明、対応プラットフォーム、主要リンクを最初にまとめられます。