🗂

JetBrainsのWritersideを試してみた

2023/10/27に公開

Markdown

この記事はなに？

2023年10月中旬くらいにJetBrainsからWritersideという、ドキュメント執筆に注力したツールが出たらしいので触ってみました。その感想？です。

殴り書きなのでおかしいところがちょいちょいあるかもしれません

とりあえず使ってみる

インストールして起動してみます。
起動後の画面は他の製品と大差ないですね。

プロジェクトの作成.....したあと

ひとまずプロジェクトを新規作成してみました。
なんか動画がありますが、これもよく見る画面ですね。

あとは、なんかテンプレートがプロジェクトに入っていました。テンプレート選択したっけな。。。。

新しいTopicの作成

サイドメニューの＋で新しいファイルを作ることができます。この単位をトピックと呼ぶそうです。
MarkdownとXMLを扱えるようですが、今回はMarkdownにしました。

トピックを作成するとき、ファイル名とトピックのタイトルを別々に入力することができます。
ということで、タイトルを「次のトピック」にして作成したものがこちら

# &#27425;&#12398;&#12488;&#12500;&#12483;&#12463;

Start typing here...

1行目にタイトルが書かれます。エスケープされて読めねぇ。。。。。
また、プレビュー画面の下部に注目すると、ナビゲーションが生えてきています。嬉しいですね。

引用

引用の記法を試してみました。

> 引用のメッセージです。  
> `{style="note"}`とすると、付加情報っぽいやつになります。
{style="note"}

> 引用のメッセージです。  
> `{style="note"}`とすると、エラーぽくになります。
{style="warning"}

このように書いたとき、以下のようになります。

引用ブロックの下に属性を書いてあげることで装飾できるようです。ちょっと面白いですね。

タブ

他にも、タブ機能を試してみます。

<tabs>
<tab title="タブ1" >
 タブの内容その1
</tab>
<tab title="タブ2" >
タブの内容その2
</tab>
</tabs>

このように書くと、文書内にタブを埋め込むことができます。

HTMLを吐いてみる

なんと、書いたものをHTMLとして吐き出すことができるらしいです。
CIにも組み込めるみたいですが、今回は試しません。

ということで手元でのビルドを試してみましょう。

ビルド構成を追加する

プロジェクトを作成してすぐは、ビルドのための構成がないので作成する必要があります。

そしたら、実行してみます。

zipファイルが出てくるので、解凍して開いてみましょう。

ローカルで開いてるからか、サイドバーがうまく読まれていなかったりナビゲーションがエラーになりますが、いい感じなページを出力することができました。

まとめ

それっぽい文書を、簡単に作ることができます。
が、PDFに出力できない（JetBrainsのチームは、htmlで十分と言っている）、既存のサイトがある場合、形式を合わせるのが難しいといった課題はありそうですが、十分に使えるツールかなとは思います。すぐに飽きてVSCodeに戻ってしまうかもしれませんが。