Angular + Typedoc + Github Page

658 Views

February 03, 19

#oss #angular #typedoc #git #Angular #Typedoc #Github Pages #ドキュメント生成 #技術解説

スライド概要

今日の献立
Angular プロジェクトのドキュメントを
Git Pageに公開するレシピ（手順を）をお話します。

profile-image
スライド一覧

フリーランスプログラマです。 Angular, CHIRIMEN Open Hardware, MDN Web Doc 推しの人です。

シェア

またはPlayer版

埋め込む »CMSなどでJSが使えない場合

ダウンロード

ダウンロード(pdf - 664.92kB)

関連スライド

slide-thumbnail

エンジニア達の「完全に理解した」Talk　#52
angular
user-img akihiko.KIgure 1.7K
slide-thumbnail

エンジニア達の「完全に理解した」Talk　#42
firefox oss mdn
user-img akihiko.KIgure 1.3K
slide-thumbnail

MDN Web Docs の翻訳を完全に理解した Gunma.web #50
oss firefox mdn
user-img akihiko.KIgure 1.2K
slide-thumbnail

MDN Web Docs 翻訳の紹介(2023.10.26.勉強会)
oss mdn git
user-img akihiko.KIgure 0.9K
slide-thumbnail

推しのOSSのご紹介とそれぞれのコントリビューション
oss chirimen angular mdn
user-img akihiko.KIgure 784
slide-thumbnail

エンジニア達の「完全に理解した」Talk　#41
oss chirimen
user-img akihiko.KIgure 424
各ページのテキスト
1.

Angular + Typedoc + Github Page Git Page 公開 3分（大嘘）クッキング

2.

自己紹介 名前：キグレアキヒコ 職業：プログラマ サラリーマンの聖地界隈で、Angular書いています Twitter：@ic_lifewood Blog：http://www.lifewood.net

3.

今日の献立 Angular プロジェクトのドキュメントを Git Pageに公開するレシピ（手順を）をお話します。

4.

材料（事前準備環境） • • • • • node v10.14.1 npm v6.5.0 Angular CLI v6.0.0 typescript ~v2.7.2 typedoc ~v0.12.0

5.

調理（公開手順） 1. angular プロジェクトの作成 2. typedoc のインストール

6.

調理（公開手順） 3. コードにコメントを実装(Java Doc形式)

7.

調理（公開手順） 4. typedoc.json 実装 出力フォルダ

8.

調理（公開手順） 5. typedoc スクリプト実装 参考: https://typedoc.org/api/

9.

調理（公開手順） 6. Github へ push

10.

調理（公開手順） 7. Github Page の設定 出力フォルダに合わせる

11.

出来上がり（公開）

12.

出来上がり（公開）

13.

試食（サンプルコード）

14.

試食（サンプルページ）

15.

ご清聴有難うございました！