neruo / note-mkdocs

Coding Note for MkDocs

Hi there 👋

note-mkdocs's Issues

リポジトリ情報をつける

todo

• 記事を書く
• 記事を公開する

note
-. モチベーション

• リポジトリ情報をつけたい
  -. 参考文献
• https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/

GitLab Pages へデプロイする

todo

• 記事を書く
• 記事を公開する

note
-. モチベーション

• GitLab Pages へデプロイし、記事を公開したい
  -. 参考文献
• https://squidfunk.github.io/mkdocs-material/publishing-your-site/#gitlab-pages

タグをつける

todo

• 記事を書く
• 記事を公開する

note
-. モチベーション

• 記事にタグをつけたい
  -. 参考文献
• https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/

注意書きを書く

todo

• 記事の概要を書く
• 記事を書く
• 記事を公開する

agenda

1. モチベーション
   • 読み進める上での注意事項を、読者に強調して伝えたい
2. 参考文献
   • https://squidfunk.github.io/mkdocs-material/reference/admonitions/

本文に注意書きを書く

todo

• 記事を書く
• 記事を公開する

note
-. モチベーション

• 本文を読み進める上で、強調して読者に注意事項を伝える
  -. 参考文献
• https://squidfunk.github.io/mkdocs-material/reference/admonitions/#usage

テーマカラーを変える

todo

• 記事を書く
• 記事を公開する

note
-. モチベーション

• テーマカラーを見やすいように変えたい
  -. 参考文献
• https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/

図を挿入する

todo

• 記事を書く
• 記事を公開する

note
-. モチベーション

• 図をきれいに挿入する
  -. 参考文献
• https://squidfunk.github.io/mkdocs-material/reference/diagrams/#using-flowcharts

表を挿入する

todo

• 記事を書く
• 記事を公開する

note
-. モチベーション

• 表をきれいに挿入する
  -. 参考文献
• https://squidfunk.github.io/mkdocs-material/reference/data-tables/

ナビゲーションをつける

todo

• 記事を書く
• 記事を公開する

note
-. モチベーション

• 記事をカテゴリで分けるために、ナビゲーションをつけたい
  -. 参考文献
• https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/?h=navigation

検索単語を予測する

todo

• 記事を書く
• 記事を公開する

note
-. モチベーション

• 検索単語を予測したい
  -. 参考文献
• https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#search-sharing

ヘッダーを編集する

todo

• 記事を書く
• 記事を公開する

note
-. モチベーション

• ヘッダーを良い感じに編集したい
  -. 参考文献
• https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-header/

ダークモードで表示する

todo

• 記事を書く
• 記事を公開する

note
-. モチベーション

• 記事をダークモードで表示したい
  -. 参考文献
• https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#color-scheme

note-mkdocs リポジトリの運用方法は？

todo

• 調べたことを、手軽に記録・更新する方法をまとめる

elements

• issue, label, milestone, project

output

• 記録・更新方法
  1. コンピュータに処理させたいことを、issueのタイトルに書く
  2. issueの説明文に、次のことを書く
     • モチベーション、コーディング例、実行結果、参考文献
  3. In Progressがnつ未満であれば、そのissueをToDo から In Progressに移す
  4. 活用方法と検索文を意識して、実現する方法をMarkdownにまとめる
  5. まとめたMarkldownをdocsフォルダに移動し、remote repository を更新する

フッターを編集したい

todo

• 記事を書く
• 記事を公開する

note
-. モチベーション

• フッターを良い感じに編集したい
  -. 参考文献
• https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/

検索結果を共有する

todo

• 記事を書く
• 記事を公開する

note
-. モチベーション

• 検索結果を他の人と共有したい
  -. 参考文献
• https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#search-sharing

画像を挿入する

todo

• 記事を書く
• 記事を公開する

note
-. モチベーション

• 画像をきれいに挿入する
  -. 参考文献
• https://squidfunk.github.io/mkdocs-material/reference/images/

コードに注意書きを書く

todo

• 記事を書く
• 記事を公開する

note
-. モチベーション

• コード内に強調して注意書きを書きたい
  -. 参考文献
• https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#code-annotations

コードブロックを書く

todo

• 記事を書く
• 記事を公開する

note

• モチベーション
  • コードを強調して書きたい
• 参考文献
  • https://squidfunk.github.io/mkdocs-material/reference/code-blocks/

数式を書く

todo

• 記事を書く
• 記事を公開する

note
-. モチベーション

• 数式をきれいに書きたい
  -. 参考文献
• https://squidfunk.github.io/mkdocs-material/reference/mathjax/

note-mkdocs リポジトリの存在意義は？

todo

• 理想・現実・問題・解決策・得られる効果をまとめる

output

1. 理想
   コンピュータに処理させたいことを、手軽にコーディングできる

2. 現実
   文献調査と試行錯誤を何度も行うことで、適切なコーディング方法を探す

3. 問題（理想と現実のギャップ）
   文献調査と試行錯誤に時間がかかる

4. 解決策
   処理させたいことに対するコーディング方法を、手軽に記録・更新・参照できるシステムにまとめておく

5. 得られる効果（価値）
   一度調べた処理させたいことであれば、手軽にコーディングできる

issueを手軽に書くには？

todo

• issue に書く内容を決める
• issue template を作成する

output

• issueに書く内容
  • モチベーション
  • コーディング例
  • 実行結果
  • まとめ

注釈を書く

todo

• 記事を書く
• 記事を公開する

note
-. モチベーション

• 主張を邪魔しない程度で、読者に補足情報を伝える
  -. 参考文献
• https://squidfunk.github.io/mkdocs-material/reference/footnotes/#usage

コードをインラインで書く

todo

• 記事を書く
• 記事を公開する

note

• モチベーション
  • コードを強調して書きたい
• 参考文献
  • https://squidfunk.github.io/mkdocs-material/reference/code-blocks/

ハイライトをつける

todo

• 記事を書く
• 記事を公開する

note
-. モチベーション

• 検索した単語にハイライトをつけたい
  -. 参考文献
• https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#search-highlighting

バージョン切り替えをつける

todo

• 記事を書く
• 記事を公開する

note
-. モチベーション

• webサイトのバージョンを切り替えたい
  -. 参考文献
• https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/

サイト名を変える

todo

• 記事を書く
• 記事を公開する

note
-. モチベーション

• Webサイト名を変更したい
  -. 参考文献
• なし

タブで切り替える

todo

• 記事を書く
• 記事を公開する

note
-. モチベーション

• 複数の書き方を見比べながら、伝えたい
  -. 参考文献
• https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=tabbed#tabbed

GitHub Pages へデプロイする

todo

• 記事を書く
• 記事を公開する

note
-. モチベーション

• GitHub Pages へデプロイし、記事を公開したい
  -. 参考文献
• https://squidfunk.github.io/mkdocs-material/publishing-your-site/#github-pages

テーマ言語を変える

todo

• 記事を書く
• 記事を公開する

note
-. モチベーション

• テーマ言語を変えたい
  -. 参考文献
• https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/

mkdocs 環境を構築するには？

todo

• 記事の概要をまとめる
• 記事を書く
• 記事を公開する

agenda

1. モチベーション
   • mkdocsの開発環境を構築したい
2. コーディング例
   • pip install mkdocs-material
3. 実行結果
   • install 結果
4. 参考文献
   • Material for MkDocs: Installation