diff options
author | Sarah German <sgerman@gitlab.com> | 2022-09-22 18:10:42 +0300 |
---|---|---|
committer | Kati Paizee <kpaizee@gitlab.com> | 2022-09-22 18:10:42 +0300 |
commit | 6ef828e917f82a7bd8a621c8a652e3127666ac37 (patch) | |
tree | 62b2f8c2f54d46bda3a58e8c45b1cad2e9777514 /layouts | |
parent | a5ac9d88bd1251c252d53680e8af0df0eef1d743 (diff) |
Add Lunr search UI components
Diffstat (limited to 'layouts')
-rw-r--r-- | layouts/default.html | 4 | ||||
-rw-r--r-- | layouts/head.html | 9 | ||||
-rw-r--r-- | layouts/header.html | 6 | ||||
-rw-r--r-- | layouts/home.html | 6 | ||||
-rw-r--r-- | layouts/search.html (renamed from layouts/instantsearch.html) | 11 |
5 files changed, 30 insertions, 6 deletions
diff --git a/layouts/default.html b/layouts/default.html index b932c75b..f0674675 100644 --- a/layouts/default.html +++ b/layouts/default.html @@ -94,7 +94,11 @@ </div> </section> <script src="<%= @items['/frontend/shared/global_imports.*'].path %>"></script> + <% if @config[:algolia] == "true" %> <script src="<%= @items['/frontend/search/docsearch.*'].path %>"></script> + <% else %> + <script src="<%= @items['/frontend/search/lunrsearch.*'].path %>"></script> + <% end %> <script src="<%= @items['/assets/javascripts/toggle_popover.*'].path %>"></script> <script src="<%= @items['/frontend/shared/clipboardjs.*'].path %>"></script> <script src="<%= @items['/assets/javascripts/badges.*'].path %>"></script> diff --git a/layouts/head.html b/layouts/head.html index df60be49..d1b264d4 100644 --- a/layouts/head.html +++ b/layouts/head.html @@ -15,6 +15,8 @@ <% if @item[:noindex] or !production_and_default_branch? %> <meta name="robots" content="noindex, nofollow"> <% end %> + +<% if @config[:algolia] == "true" %> <!--https://community.algolia.com/docsearch/required-configuration.html#introduces-global-information-as-meta-tags--> <meta name="docsearch:language" content="en" /> <% if !ENV['CI_COMMIT_REF_NAME'].nil? and stable_version?(ENV['CI_COMMIT_REF_NAME']) %> @@ -23,6 +25,10 @@ <meta name="docsearch:version" content="<%= ENV['CI_DEFAULT_BRANCH'] %>" /> <% end %> <link crossorigin href="https://3PNCFOU757-dsn.algolia.net" rel="preconnect" /> +<!-- Algolia Searching from the URL bar https://www.algolia.com/doc/tutorials/search-ui/ux-patterns/search-from-the-url-bar/ --> +<link href='/opensearch.xml' rel='search' title='Search through GitLab Docs' type='application/opensearchdescription+xml'> +<link rel="stylesheet" href="/frontend/search/docsearch.css"> +<% end %> <!-- Enable CSP headers --> <% unless ENV['DISABLE_CSP'] %> @@ -31,7 +37,6 @@ <!-- End of CSP headers --> <link rel="stylesheet" href="/frontend/shared/global_imports.css"> -<link rel="stylesheet" href="/frontend/search/docsearch.css"> <link rel="stylesheet" href="<%= @items['/assets/stylesheets/stylesheet.*'].path %>"> <link rel="stylesheet" href="<%= @items['/assets/stylesheets/highlight.*'].path %>"> <link rel="stylesheet" href="<%= @items['/assets/stylesheets/footer.*'].path %>"> @@ -76,8 +81,6 @@ <!-- you don't need to keep this, but it's cool for stats! --> <meta name="generator" content="Nanoc <%= Nanoc::VERSION %>"> -<!-- Algolia Searching from the URL bar https://www.algolia.com/doc/tutorials/search-ui/ux-patterns/search-from-the-url-bar/ --> -<link href='/opensearch.xml' rel='search' title='Search through GitLab Docs' type='application/opensearchdescription+xml'> <!-- Apple Touch Icons and Microsoft Tiles --> <link rel="apple-touch-icon" sizes="180x180" href="/assets/images/apple-touch-icon.png"> <link rel="manifest" href="/assets/manifests/site.webmanifest"> diff --git a/layouts/header.html b/layouts/header.html index e521a008..3a8be124 100644 --- a/layouts/header.html +++ b/layouts/header.html @@ -12,7 +12,11 @@ <% if @item[:searchbar].nil? %> <% location = @item.identifier.to_s.split('/')[1] %> <% unless %w(search index.erb).any?(location) %> - <div id="docsearch" class="my-2 my-lg-0"></div> + <% if @config[:algolia] == "true" %> + <div id="docsearch" class="gl-my-3 my-lg-0"></div> + <% else %> + <div class="js-lunr-form"></div> + <% end %> <% end %> <% end %> </li> diff --git a/layouts/home.html b/layouts/home.html index 3b79e055..c573033d 100644 --- a/layouts/home.html +++ b/layouts/home.html @@ -16,7 +16,11 @@ <script src="<%= @items['/frontend/header/index.*'].path %>"></script> <script src="<%= @items['/frontend/shared/global_imports.*'].path %>"></script> <script src="<%= @items['/frontend/default/default.*'].path %>"></script> - <script src="<%= @items['/frontend/search/docsearch.*'].path %>"></script> <script src="<%= @items['/assets/javascripts/badges.*'].path %>"></script> + <% if @config[:algolia] == "true" %> + <script src="<%= @items['/frontend/search/docsearch.*'].path %>"></script> + <% else %> + <script src="<%= @items['/frontend/search/lunrsearch.*'].path %>"></script> + <% end %> </body> </html> diff --git a/layouts/instantsearch.html b/layouts/search.html index 514e7273..9d33e0b8 100644 --- a/layouts/instantsearch.html +++ b/layouts/search.html @@ -3,7 +3,13 @@ <head> <%= render '/head.*' %> <link rel="canonical" href="<%= @config[:base_url] %>/search/"> + <% if @config[:algolia] == "true" %> <link rel="stylesheet" href="/frontend/search/instantsearch.css"> + <script src="<%= @items['/frontend/search/instantsearch.*'].path %>"></script> + <% else %> + <script src="/assets/javascripts/lunr.min.js"></script> + <script src="<%= @items['/frontend/search/lunrsearch.*'].path %>"></script> + <% end %> </head> <body> <%= render '/gtm.*' %> @@ -12,7 +18,11 @@ <div class="row"> <div class="col-12 mt-5"> <div class="main class pl-lg-4"> + <% if @config[:algolia] == "true" %> <div class="js-instantsearch"></div> + <% else %> + <div class="js-lunrsearch"></div> + <% end %> <%= render '/footer.*' %> </div> </div> @@ -20,7 +30,6 @@ </section> <script src="<%= @items['/frontend/shared/global_imports.*'].path %>"></script> <script src="<%= @items['/frontend/header/index.*'].path %>"></script> - <script src="<%= @items['/frontend/search/instantsearch.*'].path %>"></script> <% if production? %> <%# Add analytics only in production %> |