material.angular.io

Angular コンポーネントのドキュメント サイト

これは、Angular コンポーネントのドキュメント サイトのリポジトリです。

このサイトのバージョンは次の場合にも利用できます

• v5
• v6
• v7
• v8
• v9
• v10
• v11
• v12

貢献する

Angular マテリアルおよび CDK コンポーネント、ディレクティブ、ドキュメント コンテンツ、API ドキュメント、およびデモに対するバグは、Angular コンポーネント リポジトリで開いてください。

このリポジトリでは、ドキュメント サイト自体 (コンテンツではない) に関する問題のみをオープンしてください。これには、ナビゲーションが正しく機能しない、例やドキュメントがアクセスしやすい方法で表示されない、ドキュメント ページのレンダリングやレイアウトの問題などが含まれます。

コンテンツはどこから来たのですか?

ガイド、例、およびドキュメントのコンテンツ リポジトリ angular/material2-docs-content には、ドキュメントのコンテンツと例が含まれています。これらは以下から生成されます。

• Angular マテリアルと CDK ガイド
• 重要なコンポーネント、サービス、および指令
• CDK コンポーネント、サービス、およびディレクティブ

開発セットアップ

1. NodeJS LTS がインストールされていることを確認してください
2. Yarn がインストールされていることを確認してください
3. プロジェクトの依存関係をインストールする
   • yarn install
4. ドキュメントの内容と例を最新バージョンに更新します。
   • yarn build:content

開発サーバー

1. 開発サーバーに対してyarn start実行します。 http://localhost:4200/に移動します。

建てる

yarn prod-build実行してプロジェクトをビルドします。

単体テストの実行

1. Karma 経由で単体テストを実行するには、 yarn test実行します。

エンドツーエンドテストの実行

yarn e2e実行して、Protractor 経由でエンドツーエンドのテストを実行します。テストを実行する前に、 yarn start経由でアプリを提供していることを確認してください。

導入手順

 > yarn install
> yarn upgrade @angular/components-examples

# Development
> yarn publish-dev

# Production
> yarn publish-prod