sambuc/Pico-Search
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Clarify installation instructions

Browse Source
This commit is contained in:
Pontus Horn
2017-09-06 11:52:51 +02:00
committed by GitHub
parent 09597fa838
commit 0cf5d2243e
1 changed files with 29 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@@ -12,23 +12,23 @@ The search plugin should be executed before the pagination plugin (execution ord
## Installation
Copy the file `40-PicoSearch.php` to the `plugins` sub-folder of your Pico installation directory. Add a file named
`search.md` to your content root or the sub-folder you want to make searchable. This is your search results page. You
can leave it empty of content, but set the `Template` meta tag to a template that loops through the pages and displays
them. Your `search.md` might look like this:
* **Copy the file `40-PicoSearch.php` to the `plugins` sub-folder of your Pico installation directory.**
* **Add a file named `search.md` to your content root or the sub-folder you want to make searchable.**
This is your search results page. You can leave it empty of content, but set the `Template` meta tag to a template
that loops through the pages and displays them. Your `search.md` might look like this:
```
/*
Title: Search results
Template: search
*/
```
```
/*
Title: Search results
Template: search
*/
```
* **Add a template file with the name defined in `search.md`.**
Your template file (`search.html` in the above example) should contain something like the following section, which
lists the pages matching the search (substitute `paged_pages` for `pages` if using Pico-Pagination):
Your template file (`search.html` in the above example) should contain something like the following section, which
lists the pages matching the search (substitute `paged_pages` for `pages` if using Pico-Pagination):
```twig
<div class="SearchResults">
```twig
<div class="SearchResults">
{% if pages %}
{% for page in pages %}
<div class="SearchResult">
@@ -39,8 +39,8 @@ lists the pages matching the search (substitute `paged_pages` for `pages` if usi
{% else %}
<p>No results found.</p>
{% endif %}
</div>
```
</div>
```
Now, you should be able to visit for example `yoursite.com/search/foobar` (adjust path accordingly if putting search.md
in a sub-folder) and see the search results for "foobar" listed.