diff options
| author | Ivan Boothe <git@rootwork.org> | 2022-04-08 01:13:48 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-04-08 01:13:48 +0300 |
| commit | 7f980daaa6dbb6823a7ce1474e2329022408947a (patch) | |
| tree | 360a9cdfcbff24774788459d87646b8c703ea346 /README.md | |
| parent | 6bc1ee12cccfaae93f0851b0053ac9cb96812c0f (diff) | |
| parent | f40414b5292c3af64ee46adc9efb8f034c7465e2 (diff) | |
Merge branch 'master' into remove-image-errors
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 18 |
1 files changed, 10 insertions, 8 deletions
@@ -58,6 +58,8 @@ A technology-minded theme for Hugo based on VMware's open-source [Clarity Design * Blog with tagging and category options +* Search + * Deeplinks * Choice of whether to use [Hugo Page Bundles](https://gohugo.io/content-management/page-bundles/) @@ -784,12 +786,12 @@ Likewise, the site configuration option `showRelatedInSidebar` controls if relat ### Search -Ensure you have these settings inside your configuration files +Search is currently a BETA feature. Ensure you have these settings inside your configuration files: ```toml # config/_default/config.toml [outputs] - home = ["HTML", "RSS","JSON"] + home = ["HTML", "RSS","JSON"] ``` ```toml @@ -797,18 +799,18 @@ Ensure you have these settings inside your configuration files enableSearch = true ``` -Compose implements `fuse.js` to enable search functionality. At the time of this writing, search on these theme takes either of this forms: +[Compose](https://github.com/onweru/compose), from which this feature is derived, implements `fuse.js` to enable search functionality. At the time of this writing, search on this theme takes either of the following forms: 1. __Passive search__ - This occurs only when the user loads the search page i.e `/search/`. They can directly navigate to that url. Alternatively, the user can type you search query on the search field and click enter. They will be redirected to the search page which will contain matched results if any. + This occurs only when the user loads the search page i.e `/search/`. They can directly navigate to that url. Alternatively, the user can type the search query on the search field and hit enter. They will be redirected to the search page which will contain matched results if any. - Currently, this only works on the default language. Support for multilingual passive search coming soon. + Currently, this only works on the default language. Support for multilingual passive search is coming soon. 2. __Live search__ - This behaviour will be obvious as the user types a search query on the search field. All `valid search queries`, will yield a list of `quick links` or a simple `no matches found`. Else, the user will be prompted to continue typing. + This behavior will be obvious as the user types a search query on the search field. All valid search queries will yield a list of quick links or a simple "no matches found". Else, the user will be prompted to continue typing. - live search works even for multilingual sites. + Live search works even for multilingual sites. - For chinese-like languages, it may or may not work. + For Chinese-like languages, it may or may not work. |