LoginSignup
5
1

More than 5 years have passed since last update.

10分でVuePressをGitHub Pagesで公開できる雛形作った

Last updated at Posted at 2018-05-13

紆余曲折あって気づいたら作ってました。
5ステップでmarkdownで作るちょっとリッチなWebサイトが作れます。

VuePressで作ったこの雛形を使って10分で公開する方法
リポジトリ

必要環境

  • git
  • shell上からgitコマンドでgithubに書き込み(push)できること
    sh git@github.com コマンドで確認することができると思います。
  • yarn (VuePressが必要とする間はnpmではインストールできません)

公開に必要な5ステップ

  • githubでリポジトリを作る
  • 雛形をコピーしてyarn installする
  • .env ファイルを修正する
  • deploy.sh を実行する
  • 公開するリポジトリでGithub Pagesを有効にする

これだけでサイトを作って公開できます!
あとは.mdファイルをdocs配下にぽいぽい放り込んでいくだけ。

何が違うの?

  • github公開のためにちょっとだけ最適化してます
  • サイドバーをdocs配下のファイル名とディレクトリ名から自動的に作ります。
  • (ファイル名/ディレクトリ名でソートされます)
  • そして手順のドキュメントがありますよ!

もしよかったら使ってみてください。

5
1
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
5
1