-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add Readme with some basic information.
- Loading branch information
Showing
1 changed file
with
31 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,31 @@ | ||
# lektor-tipue-search | ||
|
||
> This is under development | ||
This is a plugin for Lektor that adds support for [tipue search](https://www.tipue.com/search/) to projects. When enabled it can generate json files in the `tipue-search/` folder automatically when the server (or build process) is run with the `-f tipue` flag. | ||
|
||
## Enabling the Plugin | ||
|
||
To enable the plugin add this to your project file, run this command while sitting in your Lektor project directory: | ||
|
||
```bash | ||
lektor plugins add lektor-tipue-search | ||
``` | ||
|
||
## Configurations | ||
|
||
You should add an entry for any model taht you want to be generated into de json file | ||
|
||
`configs/tipue-search.ini:` | ||
|
||
[blog-post] | ||
title = title | ||
text = summary | ||
tags = tags | ||
|
||
|
||
## Usage | ||
|
||
```bash | ||
lektor build -f tipue | ||
``` |