Skip to content

Commit

Permalink
Added Algolia configuration to docs (#427)
Browse files Browse the repository at this point in the history 
* Added Algolia configuration to docs

* updated index to use the same branch

* set crawler to hierarchical schema

* add hostnamealias

* Fixed chainhook doc names to match the remote

* Updated sidebar.js

* add replacement pattern for platform

* revert

* update hostnamealias to netlify's

* flip alias around

* rm extra space

* Updated algolia config details

* Added docsearch packages

* chore: update config

* chore: remove netlify file

* chore: remove local search plugin

* chore: remove docsearch package

* Removed Netlify related content

---------

Co-authored-by: Dean Chi <[email protected]>
Co-authored-by: janniks <[email protected]>
  • Loading branch information
@LakshmiLavanyaKasturi @deantchi @janniks
3 people authored Sep 6, 2023
1 parent c1b2ed3 commit d6e0a07
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 85 deletions.
13 changes: 12 additions & 1 deletion docusaurus.config.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ module.exports = {
trailingSlash: false,

plugins: [
require.resolve('@cmfcmf/docusaurus-search-local'),
require.resolve('docusaurus-plugin-segment'),
['./src/_plugins/google-tag-manager', { id: 'GTM-59XXGSG' }],
[
Expand Down Expand Up @@ -633,6 +632,18 @@ module.exports = {
darkTheme: darkCodeTheme,
additionalLanguages: ['toml'],
},
// Algolio DocSearch
algolia: {
// The application ID provided by Algolia
appId: 'UL2NZRAK8K',

// Public API key: it is safe to commit it
apiKey: '2b7f4af4606380e8e9d4a39aa9a4237f',

indexName: 'hiro',
contextualSearch: true,
searchPagePath: 'search',
},
segment: {
apiKey: 'qabJfWPhi2L9CeMk22A1XlYmabsNtgKy',
},
Expand Down
8 changes: 0 additions & 8 deletions netlify.toml
View file

This file was deleted.

1 change: 0 additions & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@
"write-translations": "docusaurus write-translations"
},
"dependencies": {
"@cmfcmf/docusaurus-search-local": "^0.11.0",
"@docusaurus/core": "^2.4.1",
"@docusaurus/module-type-aliases": "^2.4.1",
"@docusaurus/preset-classic": "^2.4.1",
Expand Down
83 changes: 8 additions & 75 deletions yarn.lock
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,6 @@
# yarn lockfile v1


"@algolia/[email protected]":
version "1.10.0"
resolved "https://registry.yarnpkg.com/@algolia/autocomplete-core/-/autocomplete-core-1.10.0.tgz#d9c7435e90993852e9aa159df7ed84d4342656cc"
integrity sha512-zaQ4ZOtGkeUvDGObZvaULuZmU4kAcVu/Wm9EP6Vzij5wQ98FAKz1uHn2EPiCI0aFIoUfZi/WhJvn5l6qVBdYEA==
dependencies:
"@algolia/autocomplete-plugin-algolia-insights" "1.10.0"
"@algolia/autocomplete-shared" "1.10.0"

"@algolia/[email protected]":
version "1.9.3"
resolved "https://registry.yarnpkg.com/@algolia/autocomplete-core/-/autocomplete-core-1.9.3.tgz#1d56482a768c33aae0868c8533049e02e8961be7"
Expand All @@ -18,60 +10,25 @@
"@algolia/autocomplete-plugin-algolia-insights" "1.9.3"
"@algolia/autocomplete-shared" "1.9.3"

"@algolia/autocomplete-js@^1.5.1":
version "1.10.0"
resolved "https://registry.yarnpkg.com/@algolia/autocomplete-js/-/autocomplete-js-1.10.0.tgz#25fb429ee0883e525e19f7d116ce6a609a330265"
integrity sha512-PpDNZs6/H5u9yOvpZ1HWb5Uf40zXOGCmhjDEfODQ6Q506hxAKhquxNLI+o8Chgda4bvRai1gGfFdZ5RSr0oHbA==
dependencies:
"@algolia/autocomplete-core" "1.10.0"
"@algolia/autocomplete-preset-algolia" "1.10.0"
"@algolia/autocomplete-shared" "1.10.0"
htm "^3.1.1"
preact "^10.13.2"

"@algolia/[email protected]":
version "1.10.0"
resolved "https://registry.yarnpkg.com/@algolia/autocomplete-plugin-algolia-insights/-/autocomplete-plugin-algolia-insights-1.10.0.tgz#1c5ba934c166cba1de9a04c5777f8346dd929379"
integrity sha512-mXKrO9gBIgjLHKfIN9aGqdMfWEXlk+ttiR1mgXrUtyMp6IKhZiXoNpvG2Xg2SiQakmZOtxagut3Wq1DpdwCq6Q==
dependencies:
"@algolia/autocomplete-shared" "1.10.0"

"@algolia/[email protected]":
version "1.9.3"
resolved "https://registry.yarnpkg.com/@algolia/autocomplete-plugin-algolia-insights/-/autocomplete-plugin-algolia-insights-1.9.3.tgz#9b7f8641052c8ead6d66c1623d444cbe19dde587"
integrity sha512-a/yTUkcO/Vyy+JffmAnTWbr4/90cLzw+CC3bRbhnULr/EM0fGNvM13oQQ14f2moLMcVDyAx/leczLlAOovhSZg==
dependencies:
"@algolia/autocomplete-shared" "1.9.3"

"@algolia/[email protected]":
version "1.10.0"
resolved "https://registry.yarnpkg.com/@algolia/autocomplete-preset-algolia/-/autocomplete-preset-algolia-1.10.0.tgz#3ffd96441f3153d59e7aaaa52dbb6e78765cac0e"
integrity sha512-CABQm+VJvuwl5XeVYbPISc8OAac7+nX+yDzG0nJRsSd64IeI6e/Jxrg13quxpTvOe7JZXYdW1y1kV7srPuFpmA==
dependencies:
"@algolia/autocomplete-shared" "1.10.0"

"@algolia/[email protected]":
version "1.9.3"
resolved "https://registry.yarnpkg.com/@algolia/autocomplete-preset-algolia/-/autocomplete-preset-algolia-1.9.3.tgz#64cca4a4304cfcad2cf730e83067e0c1b2f485da"
integrity sha512-d4qlt6YmrLMYy95n5TB52wtNDr6EgAIPH81dvvvW8UmuWRgxEtY0NJiPwl/h95JtG2vmRM804M0DSwMCNZlzRA==
dependencies:
"@algolia/autocomplete-shared" "1.9.3"

"@algolia/[email protected]":
version "1.10.0"
resolved "https://registry.yarnpkg.com/@algolia/autocomplete-shared/-/autocomplete-shared-1.10.0.tgz#3f068563c8e7c3ac369893da48a77a79408ca889"
integrity sha512-JKZGomjcUeKKtkymeZuWjKNIJU7UzuaCN3/eKlpOXxmvWCd5aJrVTDgbOm0pOjv0Ef9xVzIZx9cS/GL1Snxo1g==

"@algolia/[email protected]":
version "1.9.3"
resolved "https://registry.yarnpkg.com/@algolia/autocomplete-shared/-/autocomplete-shared-1.9.3.tgz#2e22e830d36f0a9cf2c0ccd3c7f6d59435b77dfa"
integrity sha512-Wnm9E4Ye6Rl6sTTqjoymD+l8DjSTHsHboVRYrKgEt8Q7UHm9nYbqhN/i0fhUYA3OAEH7WA8x3jfpnmJm3rKvaQ==

"@algolia/autocomplete-theme-classic@^1.5.1":
version "1.10.0"
resolved "https://registry.yarnpkg.com/@algolia/autocomplete-theme-classic/-/autocomplete-theme-classic-1.10.0.tgz#f3e9c38920d73b6f0d4a7236f9404540e733c031"
integrity sha512-YiKqXxWoQdbcxHnC9TK2PSoEHQtlqfnhBnbfejjS3U//5ASLvkF/rAcSFGfcZUzo8IvDKA/oYgK1CDQJ3+lMMQ==

"@algolia/[email protected]":
version "4.19.1"
resolved "https://registry.yarnpkg.com/@algolia/cache-browser-local-storage/-/cache-browser-local-storage-4.19.1.tgz#d29f42775ed4d117182897ac164519c593faf399"
Expand Down Expand Up @@ -127,7 +84,7 @@
"@algolia/requester-common" "4.19.1"
"@algolia/transporter" "4.19.1"

"@algolia/[email protected]", "@algolia/client-search@^4.12.0":
"@algolia/[email protected]":
version "4.19.1"
resolved "https://registry.yarnpkg.com/@algolia/client-search/-/client-search-4.19.1.tgz#5e54601aa5f5cea790cec3f2cde4af9d6403871e"
integrity sha512-mBecfMFS4N+yK/p0ZbK53vrZbL6OtWMk8YmnOv1i0LXx4pelY8TFhqKoTit3NPVPwoSNN0vdSN9dTu1xr1XOVw==
Expand Down Expand Up @@ -1272,20 +1229,6 @@
"@babel/helper-validator-identifier" "^7.22.5"
to-fast-properties "^2.0.0"

"@cmfcmf/docusaurus-search-local@^0.11.0":
version "0.11.0"
resolved "https://registry.yarnpkg.com/@cmfcmf/docusaurus-search-local/-/docusaurus-search-local-0.11.0.tgz#95ebb004a51c3e09b9ec76a39b8062510920e1ac"
integrity sha512-UzJ0G7JfrhuXJ9h79vforQZs05C5rWhXqrK7C5ie1ImHLTC4RPW7FHagIpZULhcA2PbDkc4ewnWVIufLKq+KzA==
dependencies:
"@algolia/autocomplete-js" "^1.5.1"
"@algolia/autocomplete-theme-classic" "^1.5.1"
"@algolia/client-search" "^4.12.0"
algoliasearch "^4.12.0"
cheerio "^1.0.0-rc.9"
clsx "^1.1.1"
lunr-languages "^1.4.0"
mark.js "^8.11.1"

"@colors/[email protected]":
version "1.5.0"
resolved "https://registry.yarnpkg.com/@colors/colors/-/colors-1.5.0.tgz#bb504579c1cae923e6576a4f5da43d25f97bdbd9"
Expand Down Expand Up @@ -2976,14 +2919,19 @@ ajv@^8.0.0, ajv@^8.9.0:
require-from-string "^2.0.2"
uri-js "^4.2.2"

algolia@^0.0.0:
version "0.0.0"
resolved "https://registry.yarnpkg.com/algolia/-/algolia-0.0.0.tgz#82a479264023926bce249d25f2563dd9faf8d88e"
integrity sha512-RCZAbrF6MoR9+qH2SYZDW1A0Mk2k4xOO1Jq5c/lcrgPXsAUOzMZotBlPN5ZbJifPmmQLTCE5ZL27z6cuuBFSBQ==

algoliasearch-helper@^3.10.0:
version "3.13.5"
resolved "https://registry.yarnpkg.com/algoliasearch-helper/-/algoliasearch-helper-3.13.5.tgz#0e20f6af3b2cb918e0b8bcb6f7f233bdbb53be1d"
integrity sha512-UsiDw8/RN3S/46EEJ6s5fX/vCNPlMNPQrB0TL/105Umyc+UdgbErCTaSf46pcVDIctAFN+9HF7txEg1eMHUvww==
dependencies:
"@algolia/events" "^4.0.1"

algoliasearch@^4.0.0, algoliasearch@^4.12.0, algoliasearch@^4.13.1:
algoliasearch@^4.0.0, algoliasearch@^4.13.1:
version "4.19.1"
resolved "https://registry.yarnpkg.com/algoliasearch/-/algoliasearch-4.19.1.tgz#18111fb422eaf841737adb92d5ab12133d244218"
integrity sha512-IJF5b93b2MgAzcE/tuzW0yOPnuUyRgGAtaPv5UUywXM8kzqfdwZTO4sPJBzoGz1eOy6H9uEchsJsBFTELZSu+g==
Expand Down Expand Up @@ -3728,7 +3676,7 @@ cheerio@^0.22.0:
lodash.reject "^4.4.0"
lodash.some "^4.4.0"

cheerio@^1.0.0-rc.12, cheerio@^1.0.0-rc.9:
cheerio@^1.0.0-rc.12:
version "1.0.0-rc.12"
resolved "https://registry.yarnpkg.com/cheerio/-/cheerio-1.0.0-rc.12.tgz#788bf7466506b1c6bf5fae51d24a2c4d62e47683"
integrity sha512-VqR8m68vM46BNnuZ5NtnGBKIE/DfN0cRIzg9n40EIq9NOv90ayxLBXA8fXC5gquFRGJSTRqBq25Jt2ECLR431Q==
Expand Down Expand Up @@ -5855,11 +5803,6 @@ hpack.js@^2.1.6:
readable-stream "^2.0.1"
wbuf "^1.1.0"

htm@^3.1.1:
version "3.1.1"
resolved "https://registry.yarnpkg.com/htm/-/htm-3.1.1.tgz#49266582be0dc66ed2235d5ea892307cc0c24b78"
integrity sha512-983Vyg8NwUE7JkZ6NmOqpCZ+sh1bKv2iYTlUkzlWmA5JD2acKoxd4KVxbMmxX/85mtfdnDmTFoNKcg5DGAvxNQ==

html-entities@^2.3.2:
version "2.4.0"
resolved "https://registry.yarnpkg.com/html-entities/-/html-entities-2.4.0.tgz#edd0cee70402584c8c76cc2c0556db09d1f45061"
Expand Down Expand Up @@ -6892,11 +6835,6 @@ lru-cache@^6.0.0:
dependencies:
yallist "^4.0.0"

lunr-languages@^1.4.0:
version "1.12.0"
resolved "https://registry.yarnpkg.com/lunr-languages/-/lunr-languages-1.12.0.tgz#c44d8f2127054a55c62e1aebe0b1eaea6dfc1d91"
integrity sha512-C2z02jt74ymrDocBwxYB4Cr1LNZj9rHGLTH/00+JuoT6eJOSSuPBzeqQG8kjnlPUQe+/PAWv1/KHbDT+YYYRnA==

lunr@^2.3.9:
version "2.3.9"
resolved "https://registry.yarnpkg.com/lunr/-/lunr-2.3.9.tgz#18b123142832337dd6e964df1a5a7707b25d35e1"
Expand Down Expand Up @@ -8243,11 +8181,6 @@ [email protected]:
dependencies:
punycode "^2.1.1"

preact@^10.13.2:
version "10.16.0"
resolved "https://registry.yarnpkg.com/preact/-/preact-10.16.0.tgz#68a06d70b191b8a313ea722d61e09c6b2a79a37e"
integrity sha512-XTSj3dJ4roKIC93pald6rWuB2qQJO9gO2iLLyTe87MrjQN+HklueLsmskbywEWqCHlclgz3/M4YLL2iBr9UmMA==

prepend-http@^2.0.0:
version "2.0.0"
resolved "https://registry.yarnpkg.com/prepend-http/-/prepend-http-2.0.0.tgz#e92434bfa5ea8c19f41cdfd401d741a3c819d897"
Expand Down

1 comment on commit d6e0a07

@vercel
Copy link

@vercel vercel bot commented on d6e0a07 Sep 6, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

hiro-systems-docs – ./

hiro-systems-docs-git-main-blockstack.vercel.app
hiro-systems-docs-blockstack.vercel.app
hiro-systems-docs.vercel.app
docs.hiro.so

Please sign in to comment.