-
Notifications
You must be signed in to change notification settings - Fork 0
/
document.saty
66 lines (57 loc) · 2.47 KB
/
document.saty
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
@require: stdja
@require: annot
@require: itemize
document (|
title = {\SATySFi; Gitpod Template};
author = {pickoba};
show-title = true;
show-toc = false;
|) '<
+p{
このリポジトリは \SATySFi; 用の Gitpod テンプレートです。
}
+section{文書のコンパイル}<
+p{
以下のいずれかの方法で文書をコンパイルすることができます。
\enumerate{
* ショートカットキー `ctrl`/`cmd` + `alt` + `b`
* エディタ右上のボタン(再生マーク)
* 統合ターミナルで `satysfi document.saty` を実行
}
}
>
+section{Language Server の利用}<
+p{
このテンプレートでは Language Server (\href(`https://github.com/monaqa/satysfi-language-server`){monaqa/satysfi-language-server})がセットアップ済であり、入力補完等の支援を既に受けられる状態になっています。Language Server のバイナリは以下のコマンドで更新できます(統合ターミナルで入力してください)。
}
+code(```
cargo install --git https://github.com/monaqa/satysfi-language-server
```);
>
+section{ライブラリの追加}<
+p{
通常の環境と同じく、`opam` と `satyrographos` を用いて新たなライブラリを追加できます。以下は `satysfi-base` をインストールする例です。
}
+code(```
opam install satysfi-base && satyrographos install
```);
+p{
再現可能なビルドとするためには、`.gitpod.Dockerfile` 内に記述することもおすすめです。
}
>
+section{その他コマンドの追加・設定変更}<
+p{
永続的な変更であれば `.gitpod.Dockerfile` 内に記述することをお勧めします。一時的なものの場合、統合ターミナルから `apt` などを通じて新たなパッケージを追加できます。デフォルトユーザは gitpod ですが、`sudo` はパスワードなしで使えるようになっています。
}
>
+section{連絡先}<
+p{
バグ報告等あれば以下にご連絡ください。
\listing{
* GitHub (Template): \href(`https://github.com/pickoba/satysfi-gitpod-template`){https://github.com/pickoba/satysfi-gitpod-template}
* GitHub (Docker Image): \href(`https://github.com/pickoba/gitpod-satysfi`){https://github.com/pickoba/gitpod-satysfi}
* \SATySFi; Slack: \@pickoba
}
}
>
>