SATySFi APIの宣伝
これは「SATySFi Advent Calendar 2019」の1日目の記事です。
とうとう始まりましたSATySFi Advent Calendar 2019!
楽しんでいきましょう。
SATySFiを使う時に
皆さんSATySFi使ってますよね?
このSATySFiですが、使っているとき(特にパッケージを作っているとき)に「○○の機能を持つ関数やコマンドは無いかな~」と思う時ありませんか?
また、「このコマンドや関数の使い方は何だろうか?」とか「このパッケージはどんな関数やコマンドを提供してくれるのだろうか」とか思うことは無いでしょうか?
ということでこれを解決するためにSATySFi APIというサイトを作ってみました。
使い方
まずSATySFi APIにアクセスします。すると各テーマごとにリンクが貼られているのでそれぞれのページへ飛んでください。 すると、そのテーマに合うパッケージとモジュールが照会されており、そのモジュール内で提供されている関数やコマンドの型と説明が書いてあります。
使っている技術
サイトはGitHubPagesを利用しています。 内容についてはSATySFiのテキスト出力モードを利用してHTMLファイルをsatyファイルから自動生成しています。
内容の充実化
見てわかる通り、中身はお世辞にも充実しているとは言えません。
SATySFiだけを使っているのでsatyフォルダ内にページを作り、HTMLファイルをdocsフォルダに生成させることは簡単にできます。 Pull Requestを送っていただけると嬉しいです。
今後の予定
定義コードへジャンプする機能の追加や記法の追加、モバイル端末への対応などを行っていく予定です。
将来SATySFi公式サイトができた時にデータを提供できるよう頑張っていきます。