OWASP モバイルアプリケーションセキュリティプロジェクト ウェブサイト

このリポジトリには、OWASP モバイルアプリケーションセキュリティプロジェクトのウェブサイト (mas.owasp.org) のソースと設定が含まれています。

このウェブサイトは、MkDocs と mkdocs-material テーマを使用して、主要な MAS リソースのドキュメントを集約・整理・公開しています。

各リソースは独自の GitHub リポジトリにあります:

開発

このリポジトリの 2 つの主要コンポーネントは以下のとおりです:

• docs/ ディレクトリ。ウェブサイトのすべてのソースファイルが含まれています。
• mkdocs.yml ファイル。MkDocs サイトを設定します。

サイトは、mkdocs.yml ファイル内でさまざまな MkDocs 機能とプラグインを使用しています。これには以下が含まれます:

• Material for MkDocs テーマ (theme)。カスタムアイコン、ロゴ、パレット切り替え (ライト/ダークモード) を備えています。詳細は Material for MkDocs documentation を参照してください。
• ナビゲーションタブ、スティッキータブ、インスタントナビゲーション、トラッキング (theme.features)。UX 向上のため。
• 検索 (plugins: search)。サジェストと共有機能付き。
• タグ (plugins: tags) および ブログ (plugins: blog) プラグイン。動的コンテンツの整理とニュース投稿用。
• Awesome Pages (plugins: awesome-pages)。柔軟なナビゲーション構造用。
• Redirects プラグイン (plugins: redirects)。レガシーおよび動的ページのリダイレクト用のカスタム Python フック (hooks) 付き。
• カスタムフック (hooks)。動的コンテンツ、バナー、相互参照、デモボタンなど用。
• Markdown 拡張機能 (markdown_extensions): meta、パーマリンク付き TOC、admonition、テーブル、フェンス付きコードブロック、絵文字、プログレスバー、タブ付きコンテンツ、スニペットなど。
• 追加の CSS/JS (extra_css、)。テーブル、ナビゲーション、フィルタリング、外部リンク用。

ローカル開発

ウェブサイトをローカルでビルドして提供するには、このガイド を参照してください。

デプロイ

GitHub Actions は、main へのプッシュ時にサイトをビルドしてデプロイします (.github/workflows/ を参照)。
このワークフローは、ビルド前に上流の MASTG、MASVS、MASWE リポジトリから最新のコンテンツを取得します。

貢献

ウェブサイトの改善、バグ修正、ドキュメントの更新を歓迎します! 詳細は私たちの貢献ガイドラインを参照してください。