Markdownメモのためのユーザ辞書とファイル整理小テク【Typora利用】

公開:2020/10/07
更新:2020/10/10
3 min読了の目安(約3500字IDEAアイデア記事

Markdownをリアルタイムでプレビュー可能なナイスなエディタ「Typora」。

今回は、Typora自体の機能についてではない小テクを紹介します。

素早くメモを書くことや、後で見返すことに少しでも役立ててもらえればうれしいです。

あくまで自分が利用している上での発想例ですので、自身の環境に置き換えてください。

MarkdownメモTips

利用エディタTyporaについて

ユーザ辞書登録による簡略入力

  • 概要
    • メモを取る際によく利用する文字を、辞書登録しておく
      ※登録する際の品詞は好きなものを選択

以下、よく使う順


  • 箇条書きの点
    ※半角スペースが付き
てん	* 
    • 区切りが必要な際に利用
せん	---
  • 囲い
    • 主に、ファイル名や関数名を入れる
かっこ	``
  • コード行
    • 文章の貼り付けは、主にwiki利用
うぃき	```wiki
しぇる	```shell
ぱい	```python
しー	```c
やむ	```yaml
だーと	```dart
・
・
・
まーめいど	```mermaid

ぐらふ	graph TD;A-->B;
ぐらふ	graph LR;A-->B;

しーけんす	sequenceDiagram;A->>B: C

ファイル整理

  • 概要

    • 日常の業務メモや学習メモ等、何かの情報を整理するためのテンプレートディレクトリを作成し、利用
  • 方法

    • テンプレートをコピーし、「○○業務」や「○○勉強」という意味の名前に変更
    • Markdownメモを格納
    • git hub等で管理
      • ※画像等のリンクは相対パスを記載
  • 「テンプレート」ディレクトリ構成

    • 000_uncategorized:カテゴリに分けられない(または、とりあえずの)Markdownファイル格納場所
    • 00_xxx:カテゴリに分けたMarkdownファイル格納場所
    • img:画像ファイル格納場所
    • log:ログファイル格納場所
|__README.md
|__00_xxx
|__01_xxx
|__02_xxx
|__03_xxx
|__04_xxx
|__05_xxx
|__000_uncategorized
|__img
|__log

以下、例(Flutter学習)


  • flutter(アプリ開発)を勉強するために、テンプレートをコピーし、study_flutterディレクトリに変更
|__README.md
|__000_uncategorized
|__00_initial_research
	|__initial_research_part001.md
・
・【省略】
・
|__img
	|__2020-10-07-001.png
	・
	・【省略】
	・
|__log
  • READMEファイルにリンクを記載
    • その後、学習メモをファイル追加や、必要に応じてディレクトリ作成
    • ※ディレクトリのリンクはあえてコード記載
内容 ディレクトリ
初期調査 [00_initial_research](../00_initial_research)
文法の学習①:The Flutter Framework<br />文法の学習②:Building Interactive Apps [01_udacity](../01_udacity)
アプリ作成プロセス [02_app_creation_process](../02_app_creation_process)
開発環境作成 [03_flutter_environment_creation](../03_flutter_environment_creation)
アプリ作成参考 [04_application_reference](../04_application_reference)
smallサイズアプリ複数作成 [05_small_app_creation](../05_small_app_creation)
重要公式情報と新しい知識蓄積 [06_pause_for_learning](../06_pause_for_learning)
mediumサイズアプリ作成 [07_medium_app_creation](../07_medium_app_creation)
Udemyの動画(Angela講座) [08_udemy_flutter-bootcamp-with-dart](../08_udemy_flutter-bootcamp-with-dart)
  • 備考
    • アプリ自体の管理を別のリポジトリで行う場合は、Markdownメモディレクトリ作成というよりは、
      そちらのコミットメッセージ・issue・コード内TODO・READMEで一括管理した方が分かりやすいかもしれない