Skip to content

MKdocs material プラグイン#

参考サイト#

一覧#

  • mkdocs-material-extensions: MkDocs Materialで使用できる便利な機能を追加
  • mkdocs-editable：サイトのページを直接編集する機能を追加する。
  • mkdocs-memos-plugin: MkDocs MaterialサイトをCMSとして使用可能西、サイトの管理者がブラウザ上でMarkdownを編集し、変更を保存できる。
  • mkdocs-cms-plugin: ユーザーがサイト上で簡単にメモを作成できる。
  • mkdocs-minify-plugin:生成されたHTMLファイルを圧縮し、ファイルサイズを縮小するためのプラグイン
  • mkdocs-redirects: 古いURLを新しいURLにリダイレクトするためのプラグイン
  • mkdocs-git-revision-date-localized-plugin: 各ページの最終更新日時を表示するためのプラグイン
  • mkdocs-fontawesome: FontAwesomeアイコンを使用できるようにするためのプラグイン
  • mkdocs-exclude: kDocsからページを除外するためのプラグイン

Warinig

上記機能を実装するには以下のセキュリティ対策をしておくのがベター。
1. 認証機能の実装 - MkDocs Materialサイトに認証機能を実装することで、権限のないユーザーがサイトにアクセスできないようにすることができます。例えば、GoogleアカウントなどのOAuthプロトコルを使用して認証を実装することができます。 2. IP制限の実装 - サイトにアクセスを許可するIPアドレスの制限を実装することで、権限のないユーザーがサイトにアクセスすることを防ぐことができます。ただし、IPアドレスは偽装できるため、これだけで完全に保護することはできません。 3. ユーザー権限の制御 - サイト上での編集権限を持つユーザーを制御することで、不正なアクセスを防ぐことができます。たとえば、GitHubのコラボレーターまたは所有者など、特定のユーザーだけがサイトを編集できるようにすることができます。 4. HTTPSの使用 - MkDocs MaterialサイトにHTTPSを使用することで、通信中に情報が傍受されることを防ぐことができます。