コンテンツにスキップ

Vuepress

  • Markdownを静的Wikiページにビルドできるので、次期Wikiシステム候補として調査
  • Vueと開発者が同じらしい。
  • https://vuepress.vuejs.org/

Setup

$ npx create-vuepress ainoniwa-vuepress
? Select the boilerplate type docs
? What's the name of your project? ainoniwa-vuepress
? What's the description of your project? ainoniwa.net tech research
? What's your email? ruy@ainoniwa.net
? What's your name? ruy
? What's the repo of your project. 
   create ainoniwa-vuepress/package.json
   create ainoniwa-vuepress/.gitignore
   create ainoniwa-vuepress/docs/.vuepress/components/demo-component.vue
   create ainoniwa-vuepress/docs/.vuepress/components/Foo/Bar.vue
   create ainoniwa-vuepress/docs/.vuepress/components/OtherComponent.vue
   create ainoniwa-vuepress/docs/.vuepress/config.js
   create ainoniwa-vuepress/docs/.vuepress/enhanceApp.js
   create ainoniwa-vuepress/docs/.vuepress/styles/index.styl
   create ainoniwa-vuepress/docs/.vuepress/styles/palette.styl
   create ainoniwa-vuepress/docs/config/README.md
   create ainoniwa-vuepress/docs/guide/README.md
   create ainoniwa-vuepress/docs/guide/using-vue.md
   create ainoniwa-vuepress/docs/README.md
   create ainoniwa-vuepress/README.md
✨ File Generate Done
$ npm info vuepress version
1.5.2
$ cd ainoniwa-vuepress
$ npm install
$ npm run dev
<snip>
VuePress dev server listening at http://localhost:8080/
$ npm run build
<snip>
success Generated static files in docs/.vuepress/dist.

カスタマイズ

基本は docs/.vuepress/config.js を編集。

https://vuepress.vuejs.org/guide/basic-config.html

サイドバー

https://vuepress.vuejs.org/theme/default-theme-config.html#sidebar

ナビゲーションバー

フッター(コピーライト)

最終更新日の付与(git commit基準)

https://vuepress.vuejs.org/theme/default-theme-config.html#last-updated

全文検索

https://vuepress.vuejs.org/theme/default-theme-config.html#search-box

  • デフォルトだと、ファイル名、各ドキュメントのヘッダ名でしか検索できない。
  • 全文検索したい場合は何かと連携させる必要がある。

最終更新日: 2021-05-22 13:37:13