hamaco / shouldbee-docs

ShouldBee docs

これはShouldBeeのドキュメント用リポジトリです。

インストール

hugoコマンドをインストールしておく。

brew install hugo

ドキュメント規約

1. 内部リンクのURLは/で終えること。
2. 公開する画像や添付ファイルはstaticフォルダに置く。

ドキュメントを書くとき

次のコマンドを実行するとローカルでHTTPサーバが立ち上がります。localhost:1313にアクセスすることでプレビューを見ることができます。

make server

次のコマンドで新規ドキュメント作成ができます。

hugo new <path>/<filename>.md

アップロードするとき

権限のある人が次のコマンドを実行すると、ドキュメントのHTMLがビルドされたのち、AWSのS3にアップロードできます。

make upload

元素材

画像などの元素材は./resourcesフォルダに置いてあります。