Skip to content

シスアド:Vitepressについて

効率的にドキュメントを書いたり生成、公開するために、Vitepressを導入しました。
VitepressはVue.js製の静的サイトジェネレータで、Markdownで書いたドキュメントをHTMLに変換して公開することができます。

ドキュメントを書く流れ

  1. 適当にMarkdownファイル(拡張子.md)を作成します。
  2. Markdown形式でドキュメントを書きます。
  3. おわり

基本的には、Markdownファイルを置いたらどこにでもページが作成されるので、ファイル構成を気にする必要はありません。

サイドのナビゲーションは自動更新されない!
画面左側(スマホでは格納)にあるナビゲーションは、自動で更新されず新たなものが表示されることはありません。
更新するときは、/.vitepress/config.jsを編集してください。

PDFにしたい

PDFにしたいときは、ブラウザの印刷機能を使ってください。
というのも酷かもしれませんので、このコマンドを打つとPDFに変換されます。

並び順は多分変えられます。https://github.com/condorheroblog/vitepress-export-pdf を使っています。

bash
npm run export-pdf