Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

コア:Getting Startedを書く #19

Open
Tracked by #18
sevenc-nanashi opened this issue Mar 2, 2025 · 4 comments
Open
Tracked by #18

コア:Getting Startedを書く #19

sevenc-nanashi opened this issue Mar 2, 2025 · 4 comments

Comments

@sevenc-nanashi
Copy link
Member

sevenc-nanashi commented Mar 2, 2025

内容

タイトル通り。メモ/議論用。

  • Code Groupsが使えそう?
    • でもCode Groupsの選択内容を本文で使えないのはしんどいかも(Synthesizer.initを呼んで下さい、の文を変えられない)

その他

cc: @qryxip

@Hiroshiba
Copy link
Member

Hiroshiba commented Mar 2, 2025

でもCode Groupsの選択内容を本文で使えないのはしんどいかも(Synthesizer.initを呼んで下さい、の文を変えられない)

こ~~~れはもう選択内容によって本文を変えることはできない前提でドキュメント考えるのが良さそうな気がしました。
共通となる説明をドキュメントに書き、言語依存の処理はコードかコード内のコメントに書く、みたいな。

ドキュメント: new Synthesizer()を実行します
コード: new Synthesizer()

ではなく

ドキュメント: Synthesizerインスタンスを作ります
コード: new Synthesizer()

みたいな。

@qryxip
Copy link
Member

qryxip commented Mar 2, 2025

そもそも選択内容によって本文を変えるということをしているドキュメントを見ない気がします。Polarsでもそう。なんというか、そういうことをしたいなら入口の時点で完全に別々のドキュメントを書いてそう(e.g. ONNX Runtime)。

ただPolarsでは言語タブの中にAPIドキュメントへのリンクを置くということをしているのですが、VitePressのCode Groupsには<pre><code>しか入れることができないというのであればこれもできなさそう。

あと vuejs/vitepress#2954 が対応されないというのもきつそうではありますね。

@qryxip
Copy link
Member

qryxip commented Mar 3, 2025

コードブロック以外も入れられてさらにタブ同期機能もちゃんとあるタブ機能のプラグインもあるけど、これに命運を託していいかは正直わからないですね。一応作者は(VitePressじゃないけど)Viteのコアメンバーの人らしい。

[追記1] そんなに悪いDL数でもないし、RustとかHaskellだったら十分採用レベルなんですけどね
[追記2] よく見るとメンテはちゃんとされているみたいだし、そんなに悪くないのでは?という気がしてきています

https://vitepress-plugins.sapphi.red/tabs/

tokei ./packages/vitepress-plugin-tabs
===============================================================================
 Language            Files        Lines         Code     Comments       Blanks
===============================================================================
 JSON                    1           47           47            0            0
 Markdown                2           75            0           40           35
 TypeScript             13          480          410           10           60
-------------------------------------------------------------------------------
 Vue                     2           16           12            0            4
 |- CSS                  2           91           78            0           13
 |- HTML                 2           35           35            0            0
 |- JavaScript           2           54           40            0           14
 (Total)                            196          165            0           31
===============================================================================
 Total                  18          618          469           50           99
===============================================================================

@Hiroshiba
Copy link
Member

Hiroshiba commented Mar 3, 2025

同期してほしい気はしますね!
vuejs/vitepress#2954 を期待しつつ、とりあえず決定は先延ばしにして、vitepress-plugin-tabsに変えられるかもねくらいで良いかも。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants