# 00. 概要と方針

## 1. 製品

**Ohyna**（Open Hybrid Note App、版 1.0.0）は、日本語文書を主対象に、Markdown を編集して PDF にするオープンソースです。ブラウザで編集し、プレビューで体裁を確かめてから PDF を保存します。

扱う単位は **単一文書**です。1 つの Markdown を編集し、1 つの PDF を出力します（GUI、HTTP `POST /preview`・`/pdf`・`/analyze`、CLI `pdf` / `serve`）。

| 用途 | 内容 |
|------|------|
| 編集 | Markdown 本文とドキュメント設定（表紙・色・フォントなど） |
| 検査 | 静的解析で問題を検出する。error が 0 件のときプレビュー更新と PDF 作成が進む |
| プレビュー | 用紙イメージで体裁・図・数式を確認する |
| PDF | 検査通過後に作成し、確認のうえ保存する |

---

## 2. 方針

1. **文書形式は Ohyna Markdown**（Markdown を基礎とした製品プロファイル。使える記法は本ヘルプのマニュアルと仕様書に従う）
2. **図は Mermaid**（`mermaid code` はコード表示）
3. **数式は KaTeX**（`$...$` / `$$...$$` など、および math 系フェンス）
4. **体裁は文書先頭の設定**（`ohyna:`）で定義する
5. **プレビュー更新と PDF 作成は、検査で error が 0 件のときに進む**
6. **プレビューは編集確認用、配布・印刷の基準は PDF**

---

## 3. 想定用途

- 手順書、仕様書、報告書を Markdown で作成し、PDF で配布する
- 画面で体裁を確認しながら 1 文書を仕上げる

サーバの構築や公開設定は、サービス提供者の運用に従います。ソースと公開デモは次のとおりです。

| 内容 | URL |
|------|-----|
| ソースコード | [https://github.com/GawaDev/ohyna](https://github.com/GawaDev/ohyna) |
| 公開デモ | [https://ohyna.onrender.com/](https://ohyna.onrender.com/) |
| Issue | [https://github.com/GawaDev/ohyna/issues](https://github.com/GawaDev/ohyna/issues) |

利用者向けの案内は [プロジェクトについて](../manual/07-about.md) にもあります。

---

## 4. 利用上の前提

| 項目 | 内容 |
|------|------|
| 提供形態 | 組織等が用意したサーバ上のサービス、または公開デモとして、ブラウザから利用する |
| 必須のドキュメント設定 | タイトル、色テーマ、本文フォント（またはカスタム）、言語 |
| 最終確認 | **PDF 作成後の確認** |
| データの扱い | 編集・プレビュー・PDF 作成のため、入力は接続先サービスへ送信される。秘密情報の入力は避ける |
| 不具合・問い合わせ | [GitHub Issues](https://github.com/GawaDev/ohyna/issues)。運用環境固有のことはサービス提供者へ |

---

## 5. 技術の要約（参考）

| 層 | 内容 |
|----|------|
| 文書形式 | **Ohyna Markdown** |
| 本文変換 | Markdown 系ライブラリとコードハイライト |
| 図 | Mermaid |
| 数式 | KaTeX |
| PDF | ブラウザ印刷エンジン相当 |

外部仕様との境界は [10-準拠仕様マップ.md](./10-準拠仕様マップ.md) を参照してください。

ライセンスは [MIT License](../license/01-mit.md)、第三者表記は [第三者コンポーネント](../license/02-third-party.md) です。