コンテンツにスキップ

関連コマンド チートシート

test

■mkdocs コマンド

コマンド 用途
mkdocs new [projectname] 実行に必要な最低限のフォルダとファイルを作成
mkdocs build サイトに必要なファイルを生成
mkdocs serve ローカルで確認したい場合
mkdocs gh-deploy サイトシステムを利用可能な状態にすること。配置、展開を意味する。

■mkdocs gh-deploy コマンド

mkdocs gh-deploy 参考ページ ページへ移動

コマンド 用途
-h, --help gh-deployのヘルプを表示
-q, --quiet 警告を抑制する
-v, --verbose 詳細な出力を有効にする
-f, --config-file <arg> 特定の MkDocs 設定ファイルを提供する
-s, --strict 厳密モードを有効にする。これにより、MkDocs は警告が発生した場合にビルドを中止します。
-t, --theme <theme> ドキュメントをビルドする際に使用するテーマを指定する
--use-directory-urls ページをビルドする際にディレクトリ URL を使用する（デフォルト）
--no-directory-urls ページをビルドする際にディレクトリ URL を使用しない
-c, --clean ビルド前にサイトディレクトリから古いファイルを削除する（デフォルト）
--dirty 最後のビルド以降に変更されたページのみを再ビルドする
-m, --message <message> GitHub Pages リモートブランチにコミットする際に使用するコミットメッセージ。 {sha} と {version} を展開できます。
-b, -remote-branch <branch name> GitHub Pages にコミットするリモートブランチを指定する。これは設定で指定された値を上書きします。
-r, --remote-name <remote name> GitHub Pages にコミットするリモート名を指定する。これは設定で指定された値を上書きします。
--force リポジトリへのプッシュを強制する
--no-history 新しいコミットで Git 履歴全体を置換する
--ignore-version MkDocs の古いバージョンでビルドされていないことをチェックせずに展開する
--shell Git を呼び出す際にシェルを使用する

mkdocs gh-deploy -m の記述例

1
2
3
4
5
mkdocs gh-deploy -m "It is good to write something in the message."
mkdocs gh-deploy -m "Commit {sha}, MkDocs {version}. test check."
mkdocs gh-deploy --dirty -m "It is good to write something in the message. And --dirty."
mkdocs gh-deploy --dirty -m "Commit {sha} and MkDocs {version}. And --dirty."
mkdocs gh-deploy --dirty -m "Commit {sha}, MkDocs {version}. And --dirty. And ***page を更新."

■git コマンド（使用頻度が高いものを抜粋。。）

コマンド 用途
git init ローカルリポジトリを作る
git status ファイルの状態を確認
git add ステージングエリアにファイルを登録する
git commit -m "●●●●●●" メッセージ付きで、コミットする
git branch 作成された全ブランチの一覧と、現在使用中のアクティブなブランチが確認できる。>先頭に*が付加され、緑色になっているのがアクティブの印。
git branch [***] 新規ブランチ[***]の作成
git checkout 操作対象となるブランチを指定切り替えする。カレントにする。。的な意味合い。

■参考サイト

app 参考サイト
mkdocs https://www.mkdocs.org/
mkdocs(gh-deployについて) https://www.mkdocs.org/user-guide/deploying-your-docs/
mkdocs gh-deploy 参考ページ https://fig.io/manual/mkdocs/gh-deploy
github https://techacademy.jp/magazine/6235#sec4_1

mkdocs gh-deploy 参考ページ ページへ移動

最終更新日: 2024年6月21日 14:58:10