-
Notifications
You must be signed in to change notification settings - Fork 970
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Deploy getzola/zola to getzola/zola:gh-pages
- Loading branch information
GitHub Actions
committed
Jun 12, 2024
0 parents
commit c5a8d07
Showing
252 changed files
with
28,947 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
<!doctype html> | ||
<title>404 Not Found</title> | ||
<h1>404 Not Found</h1> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
www.getzola.org |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
<!doctype html> | ||
<meta charset="utf-8"> | ||
<link rel="canonical" href="https://www.getzola.org/documentation/content/overview/"> | ||
<meta http-equiv="refresh" content="0; url=https://www.getzola.org/documentation/content/overview/"> | ||
<title>Redirect</title> | ||
<p><a href="https://www.getzola.org/documentation/content/overview/">Click here</a> to be redirected.</p> |
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,288 @@ | ||
<!DOCTYPE html> | ||
<html lang="en-gb"> | ||
<head> | ||
<meta charset="UTF-8"> | ||
<meta name="apple-mobile-web-app-capable" content="yes"> | ||
<meta name="viewport" content="width=device-width, initial-scale=1"> | ||
<meta name="description" content="Everything you need to make a static site engine in one binary."> | ||
<meta name="author" content="Vincent Prouillet"> | ||
<title>Search | Zola </title> | ||
<link rel="stylesheet" href="https://www.getzola.org/site.css"> | ||
<link rel="icon" href="https://www.getzola.org/favicon.ico"> | ||
</head> | ||
<body> | ||
|
||
<header> | ||
<a class="header__logo white" href="https://www.getzola.org/">Zola</a> | ||
<nav> | ||
<ul> | ||
<li><a class="white" href="https://www.getzola.org/documentation/" class="nav-link">Docs</a></li> | ||
<li><a class="white" href="https://www.getzola.org/themes/" class="nav-link">Themes</a></li> | ||
<li><a class="white" href="https://zola.discourse.group/" class="nav-link">Forum</a></li> | ||
<li><a class="white" href="https://github.com/getzola/zola" class="nav-link">GitHub</a></li> | ||
</ul> | ||
<div class="search-container"> | ||
<input id="search" type="search" placeholder="🔎 Search the docs"> | ||
|
||
<div class="search-results"> | ||
<div class="search-results__items"></div> | ||
</div> | ||
</div> | ||
</nav> | ||
</header> | ||
|
||
<div class="content content--reversed"> | ||
|
||
|
||
<div class="documentation"> | ||
<aside class="documentation__sidebar"> | ||
<ul> | ||
|
||
|
||
<li> | ||
<span class="documentation__sidebar__title">Getting Started</span> | ||
<ul> | ||
|
||
<li class=""> | ||
<a href="https://www.getzola.org/documentation/getting-started/overview/">Overview</a> | ||
</li> | ||
|
||
<li class=""> | ||
<a href="https://www.getzola.org/documentation/getting-started/installation/">Installation</a> | ||
</li> | ||
|
||
<li class=""> | ||
<a href="https://www.getzola.org/documentation/getting-started/cli-usage/">CLI usage</a> | ||
</li> | ||
|
||
<li class=""> | ||
<a href="https://www.getzola.org/documentation/getting-started/directory-structure/">Directory structure</a> | ||
</li> | ||
|
||
<li class=""> | ||
<a href="https://www.getzola.org/documentation/getting-started/configuration/">Configuration</a> | ||
</li> | ||
|
||
</ul> | ||
</li> | ||
|
||
|
||
<li> | ||
<span class="documentation__sidebar__title">Content</span> | ||
<ul> | ||
|
||
<li class=""> | ||
<a href="https://www.getzola.org/documentation/content/overview/">Overview</a> | ||
</li> | ||
|
||
<li class=""> | ||
<a href="https://www.getzola.org/documentation/content/section/">Section</a> | ||
</li> | ||
|
||
<li class=""> | ||
<a href="https://www.getzola.org/documentation/content/page/">Page</a> | ||
</li> | ||
|
||
<li class=""> | ||
<a href="https://www.getzola.org/documentation/content/shortcodes/">Shortcodes</a> | ||
</li> | ||
|
||
<li class=""> | ||
<a href="https://www.getzola.org/documentation/content/linking/">Internal links & deep linking</a> | ||
</li> | ||
|
||
<li class=""> | ||
<a href="https://www.getzola.org/documentation/content/table-of-contents/">Table of Contents</a> | ||
</li> | ||
|
||
<li class=""> | ||
<a href="https://www.getzola.org/documentation/content/syntax-highlighting/">Syntax Highlighting</a> | ||
</li> | ||
|
||
<li class=""> | ||
<a href="https://www.getzola.org/documentation/content/taxonomies/">Taxonomies</a> | ||
</li> | ||
|
||
<li class="active"> | ||
<a href="https://www.getzola.org/documentation/content/search/">Search</a> | ||
</li> | ||
|
||
<li class=""> | ||
<a href="https://www.getzola.org/documentation/content/sass/">Sass</a> | ||
</li> | ||
|
||
<li class=""> | ||
<a href="https://www.getzola.org/documentation/content/image-processing/">Image processing</a> | ||
</li> | ||
|
||
<li class=""> | ||
<a href="https://www.getzola.org/documentation/content/multilingual/">Multilingual sites</a> | ||
</li> | ||
|
||
</ul> | ||
</li> | ||
|
||
|
||
<li> | ||
<span class="documentation__sidebar__title">Templates</span> | ||
<ul> | ||
|
||
<li class=""> | ||
<a href="https://www.getzola.org/documentation/templates/overview/">Overview</a> | ||
</li> | ||
|
||
<li class=""> | ||
<a href="https://www.getzola.org/documentation/templates/pages-sections/">Sections and Pages</a> | ||
</li> | ||
|
||
<li class=""> | ||
<a href="https://www.getzola.org/documentation/templates/pagination/">Pagination</a> | ||
</li> | ||
|
||
<li class=""> | ||
<a href="https://www.getzola.org/documentation/templates/taxonomies/">Taxonomies</a> | ||
</li> | ||
|
||
<li class=""> | ||
<a href="https://www.getzola.org/documentation/templates/feeds/">Feeds</a> | ||
</li> | ||
|
||
<li class=""> | ||
<a href="https://www.getzola.org/documentation/templates/sitemap/">Sitemap</a> | ||
</li> | ||
|
||
<li class=""> | ||
<a href="https://www.getzola.org/documentation/templates/robots/">Robots.txt</a> | ||
</li> | ||
|
||
<li class=""> | ||
<a href="https://www.getzola.org/documentation/templates/404/">404 error page</a> | ||
</li> | ||
|
||
<li class=""> | ||
<a href="https://www.getzola.org/documentation/templates/archive/">Archive</a> | ||
</li> | ||
|
||
</ul> | ||
</li> | ||
|
||
|
||
<li> | ||
<span class="documentation__sidebar__title">Themes</span> | ||
<ul> | ||
|
||
<li class=""> | ||
<a href="https://www.getzola.org/documentation/themes/overview/">Overview</a> | ||
</li> | ||
|
||
<li class=""> | ||
<a href="https://www.getzola.org/documentation/themes/installing-and-using-themes/">Installing & using themes</a> | ||
</li> | ||
|
||
<li class=""> | ||
<a href="https://www.getzola.org/documentation/themes/creating-a-theme/">Creating a theme</a> | ||
</li> | ||
|
||
<li class=""> | ||
<a href="https://www.getzola.org/documentation/themes/extending-a-theme/">Customizing a theme</a> | ||
</li> | ||
|
||
</ul> | ||
</li> | ||
|
||
|
||
<li> | ||
<span class="documentation__sidebar__title">Deployment</span> | ||
<ul> | ||
|
||
<li class=""> | ||
<a href="https://www.getzola.org/documentation/deployment/overview/">Overview</a> | ||
</li> | ||
|
||
<li class=""> | ||
<a href="https://www.getzola.org/documentation/deployment/sourcehut/">Sourcehut Pages</a> | ||
</li> | ||
|
||
<li class=""> | ||
<a href="https://www.getzola.org/documentation/deployment/netlify/">Netlify</a> | ||
</li> | ||
|
||
<li class=""> | ||
<a href="https://www.getzola.org/documentation/deployment/github-pages/">GitHub Pages</a> | ||
</li> | ||
|
||
<li class=""> | ||
<a href="https://www.getzola.org/documentation/deployment/gitlab-pages/">GitLab Pages</a> | ||
</li> | ||
|
||
<li class=""> | ||
<a href="https://www.getzola.org/documentation/deployment/edgio/">Edgio</a> | ||
</li> | ||
|
||
<li class=""> | ||
<a href="https://www.getzola.org/documentation/deployment/vercel/">Vercel</a> | ||
</li> | ||
|
||
<li class=""> | ||
<a href="https://www.getzola.org/documentation/deployment/zeabur/">Zeabur</a> | ||
</li> | ||
|
||
<li class=""> | ||
<a href="https://www.getzola.org/documentation/deployment/cloudflare-pages/">Cloudflare Pages</a> | ||
</li> | ||
|
||
<li class=""> | ||
<a href="https://www.getzola.org/documentation/deployment/flyio/">Fly.io</a> | ||
</li> | ||
|
||
<li class=""> | ||
<a href="https://www.getzola.org/documentation/deployment/aws-s3/">AWS S3 Bucket</a> | ||
</li> | ||
|
||
<li class=""> | ||
<a href="https://www.getzola.org/documentation/deployment/docker-image/">Docker image</a> | ||
</li> | ||
|
||
</ul> | ||
</li> | ||
|
||
</ul> | ||
</aside> | ||
<div class="documentation__content"> | ||
|
||
<h1>Search</h1> | ||
<p>Zola can build a search index from the sections and pages content to | ||
be used by a JavaScript library such as <a href="http://elasticlunr.com/">elasticlunr</a>.</p> | ||
<p>To enable it, you only need to set <code>build_search_index = true</code> in your <code>config.toml</code> and Zola will | ||
generate an index for the <code>default_language</code> set for all pages not excluded from the search index.</p> | ||
<p>It is very important to set the <code>default_language</code> in your <code>config.toml</code> if you are writing a site not in | ||
English; the index building pipelines are very different depending on the language.</p> | ||
<p>After <code>zola build</code> or <code>zola serve</code>, you should see two files in your public directory:</p> | ||
<ul> | ||
<li><code>search_index.${default_language}.js</code>: so <code>search_index.en.js</code> for a default setup</li> | ||
<li><code>elasticlunr.min.js</code></li> | ||
</ul> | ||
<p>If you set <code>index_format = "elasticlunr_json"</code> in your <code>config.toml</code>, a <code>search_index.${default_language}.json</code> is generated | ||
instead of the default <code>search_index.${default_language}.js</code>.</p> | ||
<p>As each site will be different, Zola makes no assumptions about your search function and doesn't provide | ||
the JavaScript/CSS code to do an actual search and display results. You can look at how this site | ||
implements it to get an idea: <a href="https://github.com/getzola/zola/tree/master/docs/static/search.js">search.js</a>.</p> | ||
<p>If you are using a language other than English, you will also need to include the corresponding JavaScript stemmer file. | ||
See <a href="https://github.com/weixsong/lunr-languages#in-a-web-browser">https://github.com/weixsong/lunr-languages#in-a-web-browser</a> for details.</p> | ||
<h2 id="configuring-the-search-index"><a class="zola-anchor" href="#configuring-the-search-index" aria-label="Anchor link for: configuring-the-search-index">🔗</a>Configuring the search index</h2> | ||
<p>In some cases, the default indexing strategy is not suitable. You can customize which fields to include and whether | ||
to truncate the content in the <a href="https://www.getzola.org/documentation/getting-started/configuration/">search configuration</a>.</p> | ||
|
||
|
||
</div> | ||
</div> | ||
|
||
</div> | ||
<footer> | ||
©2017-2024 — <a class="white" href="https://www.vincentprouillet.com">Vincent Prouillet</a> and <a class="white" href="https://github.com/getzola/zola/graphs/contributors">contributors</a> | ||
</footer> | ||
|
||
<script type="text/javascript" src="https://www.getzola.org/elasticlunr.min.js"></script> | ||
<script type="text/javascript" src="https://www.getzola.org/search.js"></script> | ||
</body> | ||
</html> |
Oops, something went wrong.