Edited at

VuePressはコーダーの夢を見るか。

More than 1 year has passed since last update.

Webサービス界隈の優秀な人たちが、フロントエンドの新しいツールを「最高!」と日々謳っている中、

底辺コーダーの我々はクライアントからの修正横目に

「ほーん。どうせ僕らの業務じゃ使えないんでしょ?」という冷淡な姿勢を貫き通していた。

しかし、興味がないわけではなかった。ReactやVueといったコンポーネント思考のフレームワークを駆使すればクライアントからの無理難題をスマートに解決し、家で有意義にダラダラする時間を手に入れる事が出来るかもしれない。そのような考えはいつも心の片隅にあったが目を背け続けてきた。

でもついにその時がきたかもしれない。VuePressがその夢を叶えてくれるかもしれない。

(タイトルはかっこつけただけで特に意味はないです。)



夢と苦悩


  • 夢その1 Nuxt

  • 夢その2 Gatsbyjs

  • 夢その3 VuePressを使えるレベルにする。


    • 開発のディレクトリ構成をいい感じに

    • metaタグをページ毎に変える。

    • 言語設定を日本語にする。

    • タイトルを変更する。

    • オリジナルテーマを作る。

    • pugを使う。

    • YAMLでコンテンツ管理する。

    • Babelを使う。

    • ルートディレクトリを指定する

    • Google Analyticsの設定

    • おまけ


      • Vueでグローバルなイベントを作りたい。

      • アニメーション

      • 他に気にすべきこと






夢その1 Nuxt

ちまたではNuxt最高!のモードが高まっているが、僕はそうは思わない。あいつはStatic GeneratorのふりをしているがStaticGeneratorではない。(別にふりはしてない)

ContentfullやPrismic.ioといったHeadlessCMS+Netlifyという環境において最高なだけだ。

generateコマンドを打って生成されたファイルはリクエストを送っている。つまり外部APIがないと基本は動かない。外部APIを使わないでコンテンツを管理しようとするとNuxtはめんどくさい。

~そしてsample.jp/about.htmlみたいな生成はできない。全てindex.htmlになる。~こちら出来る様です。https://nuxtjs.org/api/configuration-generate#subfolders

これで奴らが納得するか?いや納得しないであろう。儚い夢であった。(間違ってても怒らないで)


夢その2 Gatsbyjs

React製のStatic Generator。こいつは割と本命だった。こいつはStatic Generatorとしてこの世に生を受けたからだ。

当初はReactのJSXには抵抗があった。jadeやpugで楽を覚えたのに、タグを書いている人間が信じられなかった。pugのローダーがうまく動かん。どれがベストプラクティスなのだ。reduxなんてごついものは僕らにはいらない。...というような理由でVueが本当はよかったのだが、お前しかいないのならそこは目をつぶろうとした。しかし Gatsby buildしてみたらどうだろうか。アセットがrootディレクトリにしっちゃかめっちゃかになる。Regroup non-static files into a public's subdirectoryGraphqlのコンテンツ管理はよくできていた。だけどここでさようならだ。Goodby Gatsby.Thank you Gatsby. おまえはまだGreatではない。(でもまだ大丈夫。明日はもっと速く走ろう。)(間違ってても怒らないで)


夢その3 VuePressを使えるレベルにする。

はい。ここからが本題。

基本的な使い方はまとめてくれている方がいるのでそちらを参考に。

VuePress をお試ししてみた


開発のディレクトリ構成をいい感じに

yarn add -D vuepress

└── vuepress-starter

├── .babelrc
├── .editorconfig
├── .envrc
├── .gitignore
├── README.md
├── package.json
├── src
│   ├── .vuepress
│   │   ├── config.js
│   │   ├── enhanceApp.js
│   │   ├── public
│   │   ├── script
│   │   └── theme
│   ├── about
│   │   └── index.md
│   ├── assets
│   │   ├── fonts
│   │   └── images
│   └── index.md
├── yarn-error.log
└── yarn.lock

はこんな感じ


package.json

"scripts": {

"dev": "vuepress dev src",
"build": "vuepress build src"
},

こんな感じでディレクトリを指定しとく

Inside an Existing Project

これは好みだからやらなくても良い。


metaタグをページ毎に変える。

metaタグは下記みたいな感じでグローバルの設定ができる。


src/.vuepress/config.js

module.exports = {

title: 'Hello VuePress GLOBAL',
description: 'Just playing around',
head: [
['link', { rel: 'icon', href: `/logo.png` }],
['meta',{ name:"keywords", content:"key, words, vuepress"}],
['meta',{ name:"og:title", content:"og title"}],
['meta',{ name:"og:description", content:"description"}],
['meta',{ name:"og:type", content:"website"}],
['meta',{ name:"og:url", content:"og url"}],
['meta',{ name:"og:image", content:"http://test.jp/logo.png"}],
]
}

そして個別ページのmetaを変えたいときは

各ページのfrontmatterに


src/index.md

---

title: Home Title
description: Home description
meta:
-
og:title: 'og title Home page'
-
og:desciption: 'og Home description'
-
og:image: 'https//test.jp/thisog.jpg'
---

こんな感じで書いてやると上書きできる!

(参考:https://github.com/vuejs/vuepress/blob/8bbc5f30c7d2458ae2e5cb3f67709350e84a179c/lib/build.js)

SSR後じゃないと反映されない。

ちなみに今更だけど新しくページを作りたいときは.mdファイルを置いてやれば良い。

src/sample.md

src/about/index.md

/sample.html

/about/index.html


言語設定を日本語にする。

デフォルトだとlang="en-US"になっているので、日本向けの時は変えてやる。

ページのmdファイルのfrontmatterに

---

lang: ja
---

を記載するとそのページだけ変わる。(SSR後に反映される。)

すべてのページ追記するのは冗長なので、デフォルトのthemeにはi18nが入っているのでそこの設定をいじる。

この辺に書いてある https://github.com/vuejs/vuepress/blob/2f0da0103dbc952023caffdfdb726f117ca3163d/docs/guide/i18n.md


src/.vuepress/config.js

module.exports = {

base: '/',
locales: {
'/': {
lang: 'ja',
title: 'Hello VuePress GLOBAL',
description: 'Just playing around',
head: [
['link', { rel: 'icon', href: `/logo.png` }],
['meta',{ name:"keywords", content:"key, words, vuepress"}],
['meta',{ name:"og:title", content:"og title"}],
['meta',{ name:"og:description", content:"description"}],
['meta',{ name:"og:type", content:"website"}],
['meta',{ name:"og:url", content:"og url"}],
['meta',{ name:"og:image", content:"http://absolute-domain.jp/logo.png"}],
]
}
},
...
}


タイトルを変更する。

デフォルトのタイトルが

$SITE_TITLE | $PAGE_TITLE

みたいな感じなのでここを変えたい。

$PAGE_TITLEだけにしたい or $PAGE_TITLE | $SITE_TITLEみたいにしたい場合。

.vuepress/enhanceApp.jsをいじる。

VuePressはデフォルトでdataMixin.jsを継承してる。

そのなかにtitleの記述があるのでそれを上書きしてやれば良い。

https://github.com/vuejs/vuepress/blob/236224df4cb8424c7e75892c4bea49b2a6cb7cf4/lib/app/dataMixin.js


src/.vuepress/enhanceApp.js

import headerMixin from './script/headerMixin'

export default ({
Vue,
options,
router
}) => {
Vue.mixin(headerMixin)
}


src/.vuepress/script/headerMixin.js

import Vue from 'vue'

export default {
computed: {
$title () {
const page = this.$page
const siteTitle = this.$siteTitle
const selfTitle = page.frontmatter.home ? null : (
page.frontmatter.title || // explicit title
page.title // inferred title
)
return (selfTitle) ? selfTitle : siteTitle | ''
}
}
}


こんな感じにしてやる。


オリジナルテーマを作る。

Custom Themes

ここをみるとこからスタート。

vuepress eject [targetDir]

をすればdefaultのthemeを取得できる

Customizing the Default Theme

src/.vuepress/theme

をいじっていく。

src/.vuepress/theme/layout.vue

がテンプレートファイル


pugを使う。

普通にpug-loaderをつかえやええのか?とか思ってたが、

https://github.com/vuejs/vuepress/issues/146

ここ見るとpug-plain-loader使ってた。軽いぽい。ということで

yarn add pug-plain-loader pug -D


src/.vuepress/config.js

module.exports = {

chainWebpack: config => {
config.module
.rule('pug')
.test(/\.pug$/)
.use('pug-plain-loader')
.loader('pug-plain-loader')
.end()
},
}


vue/.vuepress/theme/Home.vue

<template lang="pug">

.home
.hero
img(v-if="data.heroImage" :src="$withBase(data.heroImage)" alt="hero")
h1 {{ data.heroText || $title || 'Hello'}}
p.description {{ data.tagline || $description || 'Welcome to your VuePress site' }}
p.action(v-if="data.actionText && data.actionLink")
NavLink(class="action-button" :item="actionLink")
.features(v-if="data.features && data.features.length")
.feature(v-for="feature in data.features")
h2 {{ feature.title }}
p {{ feature.details }}
Content(custom)
.footer(v-if="data.footer") {{ data.footer }}

</template>


はい。使えた。


YAMLでコンテンツ管理する。

まず、layout.vueをシンプルにしてみる。


vue/.vuepress/theme/Home.vue

<template lang='pug'>

.theme-container(:class="pageClasses")
.custom-layout(v-if="$page.frontmatter.layout")
component(:is="$page.frontmatter.layout")
Home(v-else-if="$page.frontmatter.home")
Page(v-else)
</template>

$pageにそのページのmdで記述した変数が入っている。見てもらえばわかるように、

frontmatterのlayoutで使うテンプレートを指定できるようになっている。

---

layout: home

とすればこのページではHomeコンポーネントを使うように指定できる。こんな感じでページごとにコンポーネントを変えてコーディングしていけば良い。

そしてfrontmatterにコンテンツの情報を記述していく。

contents:

main:
title: タイトルだよ
slide:
-
title: slide_image1
-
title: slide_image2
-
title: slide_image2
sections:
-
title: セクションタイトルだよ1
text: |-
ここにセクションの文章が入るよ。入るよ。ここにセクションの文章が入るよ。入るよ。ここにセクションの文章が入るよ。入るよ。ここにセクションの文章が入るよ。入るよ。
ここにセクションの文章が入るよ。入るよ。ここにセクションの文章が入るよ。入るよ。ここにセクションの文章が入るよ。入るよ。
ここにセクションの文章が入るよ。入るよ。
-
title: セクションタイトルだよ2
text: |-
ここにセクションの文章が入るよ。入るよ。ここにセクションの文章が入るよ。入るよ。ここにセクションの文章が入るよ。入るよ。ここにセクションの文章が入るよ。入るよ。
ここにセクションの文章が入るよ。入るよ。

そして使いたいコンポーネントで

<template lang="pug">

.home
Main(v-bind:contents=`main`)
Slide(v-bind:contents=`slide`)
Section(
v-for=`section,index in sections`
v-bind:section=`section`
v-bind:key=`index`)

</template>

<script>
import Main from '../components/Main'
import Slide from '../components/Slide'
import Section from '../components/Section'

export default {
components: { Main, Slide, Section },

computed: {
main (){
return this.$page.frontmatter.contents.main
},
slide(){
return this.$page.frontmatter.contents.slide
},
sections(){
return this.$page.frontmatter.contents.sections
},
}
}
</script>

とかする。


Babelを使う。

async awaitとか使いたい。polyfillとかいい感じにしたい。

しかしながらVuePressはデフォルトだとbabelを使っていないので色々できない。

VuePressはBubble使っている。これを切ってbabelに切り替える。

https://github.com/vuejs/vuepress/issues/124

なんでbubbleなんか使ってるんや?

Evan Youさん) 軽くて早いからやで

と言っているのでしょうがない。仕事で使う場合は色々対応しなきゃだめなんや。。bubbleさいなら。

こいつらをinstallする。dynamic-importもdeafult themeには必要。


package.json

"babel-core": "^6.26.0",

"babel-loader": "^7.1.4",
"babel-plugin-syntax-dynamic-import": "^6.18.0",
"babel-preset-env": "^1.6.1",

.babelrcをrootにおく。


.babelrc

{

"presets": [
["env", {
"targets": {
"browsers": ["ie 10", "safari >= 7"]
},
"useBuiltIns": true
}]
],
"plugins": ["syntax-dynamic-import"]
}


src/.vuepress/config.js

module.exports = {

chainWebpack: config => {
const jsRule = config.module.rule('js')
jsRule.uses.delete('buble-loader')
jsRule.use('babel-loader').loader('babel-loader')
}
}

うりゃ。これでOK.

ちなみに、VuePressは webpack4使ってる。

CommonsChunkPluginグッバイ

optimization.splitChunksこんにちは。

最適化していく時はこの辺見た方が良い。

webpack 4 の optimization.splitChunks の使い方、使い所 〜廃止された CommonsChunkPlugin から移行する〜 - Qiita

ちなみにVuePressデフォルトのwebpack設定はここ見る。 https://github.com/vuejs/vuepress/blob/130c5a8468960dfacf788212f9d51f1874e3ca9c/lib/webpack/createBaseConfig.js


ルートディレクトリを指定する

以下のようなディレクトリ配下に制作したファイルを展開しないといけない場合

http://sample.io/testdir/

そういう時には


src/.vuepress/config

module.exports = {

base: `/testdir/`
dest: `dist/testdir/`,
...
}

などと設定してやれば良い。

この辺参照

ちなみにお手軽にbuild後のファイルを確認したいときは

yarn add http-server

package.jsonに以下を追記

"preview": "http-server ./dist/"

yarn build

yarn preview

で確認したら楽。


Google Analyticsの設定

デフォルトでGAに対応している。

ga


configファイルに追記

ga: 'TEST_ID_20180514'

でいける。

該当部分はここvuepress/lib/app/clientEntry.js

build後のソースコード

function(t, e, n) {

"use strict";
n(247);
var r, o, i, a, s, u, c = n(243),
f = (n(111), (0, c.createApp)()),
l = f.app,
p = f.router;
r = window, o = document, i = "script", a = "ga", r.GoogleAnalyticsObject = a, r.ga = r.ga || function() {
(r.ga.q = r.ga.q || []).push(arguments)
}, r.ga.l = 1 * new Date, s = o.createElement(i), u = o.getElementsByTagName(i)[0], s.async = 1, s.src = "https://www.google-analytics.com/analytics.js", u.parentNode.insertBefore(s, u), ga("create", "TEST_ID_20180514", "auto"), ga("send", "pageview"), p.afterEach(function(t) {
ga("set", "page", t.fullPath), ga("send", "pageview")
}), p.onReady(function() {
l.$mount("#app")
})
},

いけてるくさい。


おまけ


Vueでグローバルなイベントを作りたい。

modalは共通で利用するけど中身だけ置き換えたいみたいなとき。

enhanceApp.jsで

Vue.prototype.$eventHub = new Vue()

してやれば、

modalコンポーネントではこんな感じでイベントを見て


created () {
this.$eventHub.$on('modalOpen',this.open)
},
beforeDestroy(){
this.$eventHub.$off('modalOpen')
},
methods:{
open(url){
this.$modal.show('mymodal')
this.change(url)
},
}

呼び出したいコンポーネントで

methods: {

click(url){
this.$eventHub.$emit('modalOpen',url)
},
},

を呼んでやればmodalコンポーネントのopenを発火できる。

簡単にやりたいときはこのやり方でも良いけど複雑になってきたらvue storeを使った方が良さげぽい。

参考:Create a global event bus in Vue.js


アニメーション

Nuxtですがこちら見ればOK

Vue.js(Nuxt.js)でアニメーションやってみたら最高だった話。


他に気にすべきこと


  • SSRなので使えないライブラリもある。使うライブラリがssr対応しているか確認する。最悪dynamic-importで逃げる。

  • SNSのembed系がめんどい時ある。iframeとか。

  • 上記のやり方がすぐ使えなくなるなんてことはもちろんある。

てなてな感じ。いけるのかこれ?いけるのかこれ?!感触良いぞVuePress!夢を見せてくれ!


※基本的に、僕はVueも素人なので間違ってるところあったらごめんなさい。あとVuePressのバージョンは0.8.4です。変更すぐあって使えなくなる可能性大です。

buildファイル : http://disagreeable-thrill.surge.sh/testdir/

github (Notosansいるんで重いです。)