https://github.com/neruo/note-mkdocs

Coding Note for MkDocs
https://github.com/neruo/note-mkdocs

mkdocs mkdocs-material

Last synced: 3 months ago
JSON representation

Coding Note for MkDocs

• Host: GitHub
• URL: https://github.com/neruo/note-mkdocs
• Owner: neruo
• License: mit
• Created: 2022-08-06T12:47:49.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-11-06T11:04:02.000Z (about 2 years ago)
• Last Synced: 2023-03-02T03:34:25.903Z (almost 2 years ago)
• Topics: mkdocs, mkdocs-material
• Homepage: https://neruo.github.io/note-mkdocs/
• Size: 3.82 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 24
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# note-mkdocs

このリポジトリは、mkdocsを手軽に使う方法についてまとめたリポジトリです

## Motivation

- コンピュータに処理させたいことを、手軽にコーディングしたい

- しかし、納得するコーディング例を見つけるまで、文献調査と試行錯誤に時間がかかる

- そこで、一度調べたコーディング例を、手軽に記録・更新・検索できる mkdocs にまとめておく

- その結果、一度調べたコーディング例であれば、時間をかけずにコーディングできるようになる

## Contibution

1. issueを書き、milestone、projectを付与する

   - タイトル：コンピュータに処理させたいこと

   - 説明文：モチベーション、コーディング例、実行結果、参考文献

1. issue を ToDo から In Progress へ移し、記事を書く（ただし、In Progress は４つまで）

1. 執筆した記事を docs フォルダに移し、リモートリポジトリを更新する

1. GitHub Pages に反映されたか確認する

## Role

- issue: 各記事、mkdocs におけるサイドバー（プライマリ）

- issueのセクション：各記事のセクション、mkdocs におけるサイドバー（セカンダリ）

- milestone: 各記事のカテゴリ、mkdocs におけるナビゲーションバー

- project：書く記事（issue）を管理するカンバンボード

  - ToDo：これから書く記事

  - In Progress：今書いている記事（WIP：4）

  - Done：書き終えた記事

- branch：現在書いている最中の記事

## Reference

- [Mkdocs](https://www.mkdocs.org/)

- [Material for Mkdocs](https://squidfunk.github.io/mkdocs-material/)