🤖

Playground MarkdownのCheet sheetを作ってみた

2022/03/13に公開

Playground Markdown

Tutorialとして配布されているPlaygroundがきれいにまとまっていて便利
Combineの文法をメモするのに利用したいと思ったのでまとめる

サンプルのプロジェクトはこちらから
https://github.com/haji44/PlaygroundCheet

有効にする方法

Editor -> Show Renderd Markupをチェックする
MarkDownが認識される

Cheet Sheet

基本的な文法

//:# Header
//:## Header2
//:### Header3

/*: Bullet points
+ list item 1
+ list item 2
+ list item 3
*/

/*: Numbered lists:
1. list item
1. list item
1. list item
*/

/*:
- *Italic fonts* with a single _leading_ and _trailing_ * or _
- **Bold fonts** with a **double leading and trailing** ** or __
*/

/*:
 \````
 let indices1 = Array(0..<10)
 let indices2 = Array(0..<5)

 for i in indices1 {
 for j in indices2 {
 print (i*j)
 }
 }
 \````
*/


/*:
There are just a few link types:

 - [external playground link with a link description](http://www.allaboutswift.com)
 - [internal playground link pointing to a page named "page"](page) **or**
 - internal playground link pointing to the **[previous page](@previous)** or **[next page](@next)**
 */


/*:
 - callout(Custom callout): FYI only
 - experiment: Let's see ...
 - note:What's that?
 - important: Don't forget this !
 - example: Something like this
*/
  • 新規ページの追加方法

  • ページの順序
    XcodeのFile Inspectorで並んでいる順序がページの並び順と一致している

Tips紹介のコーナー

使うと便利な機能 その1 ショートカット

Previewなどがないので,MarkDownのレンダリングを切り替えたいときが発生する
Show Rendered Markupにキーボードショートカットを割り当てると切り替えが簡単!

使うと便利な機能その2 Codeスニペット

各ページ共通のコード,例えばPlaygroundページ間でのNavigationなどをなんども書くのは面倒なので登録する
例として,Header部分に実装する内容をスニペットに登録する

  • プレビューのイメージ
  • コード
/*:
 [<- Previeous](@previous)                [Home](Home)                       [Next ->](@next)
 # PageTitle
*/

作り方の手順

  1. 登録したいコードを選択した状態でCreate Code Snipetをチェックする
  1. 編集画面が表示されるので,項目ごとの設定

詳細な作り方はこちらが参考になりました
https://dev.classmethod.jp/articles/create-code-snippet/

参考資料

https://www.youtube.com/watch?v=iy-sG8OGT9M&t=1040s

GitHubで編集を提案

Discussion