From 5a95d9f59a1b582d132e9c1ef20ef774e8a8f11e Mon Sep 17 00:00:00 2001 From: Kiro Risk <565580+krisk@users.noreply.github.com> Date: Sun, 8 May 2022 13:53:59 -0700 Subject: [PATCH] docs: add twitter follow --- .../TwitterFollow/TwitterFollow.vue | 24 +++++++++++++++++++ docs/.vuepress/config.js | 3 ++- docs/.vuepress/styles/index.styl | 2 ++ docs/README.md | 4 ++++ docs/api/options.md | 2 ++ docs/concepts/scoring-theory.md | 2 ++ docs/demo.md | 2 ++ docs/examples.md | 4 ++++ 8 files changed, 42 insertions(+), 1 deletion(-) create mode 100644 docs/.vuepress/components/TwitterFollow/TwitterFollow.vue diff --git a/docs/.vuepress/components/TwitterFollow/TwitterFollow.vue b/docs/.vuepress/components/TwitterFollow/TwitterFollow.vue new file mode 100644 index 000000000..e027bbedd --- /dev/null +++ b/docs/.vuepress/components/TwitterFollow/TwitterFollow.vue @@ -0,0 +1,24 @@ + + + diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 32b4a525c..4efe8d17a 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -95,7 +95,8 @@ function getPlugins() { getComponent('Demo'), getComponent('Team'), getComponent('Jobs'), - getComponent('Donate') + getComponent('Donate'), + getComponent('TwitterFollow') ] } ] diff --git a/docs/.vuepress/styles/index.styl b/docs/.vuepress/styles/index.styl index 05f21bd38..fe553d804 100644 --- a/docs/.vuepress/styles/index.styl +++ b/docs/.vuepress/styles/index.styl @@ -368,12 +368,14 @@ h2 { border-bottom: none; } +// Twitter nav.nav-links div:nth-child(3) a { background-image: url(/assets/img/twitter.svg); background-repeat: no-repeat; padding-left: 30px; /* width of the image plus a little extra padding */ } +// Github nav.nav-links div:nth-child(4) a { background-image: url(/assets/img/github.svg); background-repeat: no-repeat; diff --git a/docs/README.md b/docs/README.md index 96ad537ce..4b6b914c3 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,6 +4,10 @@ shareTitle: Fuse.js - JavaScript fuzzy-search library # What is Fuse.js? + + + + Fuse.js is a **powerful, lightweight fuzzy-search library, with zero dependencies**. diff --git a/docs/api/options.md b/docs/api/options.md index 804c3e42e..15d2fb9bc 100644 --- a/docs/api/options.md +++ b/docs/api/options.md @@ -5,6 +5,8 @@ tags: # Options + + ## Basic Options ### `isCaseSensitive` diff --git a/docs/concepts/scoring-theory.md b/docs/concepts/scoring-theory.md index 0c640e252..80f707c9d 100644 --- a/docs/concepts/scoring-theory.md +++ b/docs/concepts/scoring-theory.md @@ -1,5 +1,7 @@ # Scoring Theory + + Once we have a list of matching items, they need to be ranked by a **relevance score**. This score is determined by three factors: - Fuzziness score diff --git a/docs/demo.md b/docs/demo.md index c7913fb1c..c7dab0d05 100644 --- a/docs/demo.md +++ b/docs/demo.md @@ -1,5 +1,7 @@ # Live Demo + + Play around with a live demo of Fuse.js. Have a look at the [options](api/options.html) to understand what they mean.