ReadmeToSlide

README.md is a slide.

Contents

• これは何 (What)
• 使い方 (Usage)
• 設定変更 (Settings)

これは何？

GitHubやGitLabにあるPages機能を使ってREADMEをスライド化し、デモや機能紹介等にそのまま使えるようにしようというツールです。

使い方

GitHubとGitLabでは使い方が違います。 GitLabの方はCIが組み込まれている分光機能ですが、GitLabも各種CIツールを使えば同じように出来ると思います。

GitHub - 3

あとはGitHubPagesを開けばREADME.mdがめでたくスライド化されていると思います。

あっ、大事なことを忘れてました。 初期設定では各ページ区切りの認識は改行コード3つになっていますので、それに合わせてREADME.mdを調節してくださいね。

また、MaterのREADMEを変更したらその都度gh-pagesブランチのREADME.mdもMasterからコピーしなおさなくてはいけません。

GitLab - 1

GitLabはCIが組み込まれているので、GitHubのようにブランチを分ける必要がありません。

English

English version is not yet.I wanted a translator.

というわけで

ReadmeToSlideの説明でした。