Skip to content

Commit

Permalink
Add Readme with some basic information.
Browse files Browse the repository at this point in the history
  • Loading branch information
rlaverde committed Mar 10, 2017
1 parent f544243 commit 9399e86
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions README.md
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
```

0 comments on commit 9399e86

Please sign in to comment.