facebook twitter hatena line google mixi email

「Javascript/vue/vuepress」の版間の差分

提供: 初心者エンジニアの簡易メモ
移動: 案内検索
(全文検索API)
(結果数)
行72: 行72:
 
#しばらくすると検索に全文検索結果が出てくるはず。
 
#しばらくすると検索に全文検索結果が出てくるはず。
  
===結果数===
+
===検索結果件数===
 
  algolia: {
 
  algolia: {
 
   apiKey: '<API_KEY>',
 
   apiKey: '<API_KEY>',
行81: 行81:
 
   },
 
   },
 
  }
 
  }
 +
hitsPerPageを10にすると10件に増える。(デフォは5件)
  
 
参考:https://stackoverflow.com/questions/52019383/vuepress-algolia-increase-results
 
参考:https://stackoverflow.com/questions/52019383/vuepress-algolia-increase-results

2019年7月10日 (水) 16:18時点における版

vuepressとは

Markdownのドキュメントジェネレーター

サイトデザインなど変更

設定ファイル

.vuepress/config.js

カスタム変数用意

.vuepress/scripts/string.js

const string = {
    example: {
        mail: "hoge@example.com"
    }
}
export default {
    computed: {
        $string () {
            return string
        }
    }
}

.vuepress/enhanceApp.js

import strings from "./scripts/string"
export default ({
      Vue,
      options,
      router,
      siteData
}) => {
      Vue.mixin(strings);
}


example1.md

ver:{{$string.example.mail}}'

全文検索API

Algoliaが使える。https://www.algolia.com/users/sign_in

algoliaとはSaaSの全文検索エンジンサービスで広告を表示すれば無料で使える。 無料で24時間毎にクロールしてくれる。

Algolia DocSearch申請

https://community.algolia.com/docsearch/#join-docsearch-program

こんな感じの結果が1日で来る

apiKey: 'bb637hogehogegehohogehogegehohogehogegehoge',
indexName: 'gehogehoge',
https://github.com/algolia/docsearch-configs/blob/master/configs/hogehoge.json


参考:https://kitigai.hatenablog.com/entry/2019/04/04/133432

やり方

.vuepress/config.js

module.exports = {
  themeConfig: {
    algolia: {
      apiKey: '<API_KEY>',
      indexName: '<INDEX_NAME>'
    }
  }
}
  1. 既にmodule.exports/themeConfig構成がある場合は、そこに混ぜないと、上書きしてしまうので注意。
  2. しばらくすると検索に全文検索結果が出てくるはず。

検索結果件数

algolia: {
  apiKey: '<API_KEY>',
  appId: '<API_ID>',
  indexName: '<INDEX_NAME>'
  algoliaOptions: {
    hitsPerPage: 10,
  },
}

hitsPerPageを10にすると10件に増える。(デフォは5件)

参考:https://stackoverflow.com/questions/52019383/vuepress-algolia-increase-results

参考

https://qiita.com/dojineko/items/aae7e6d13479e08d49fd