Skip to content

mikegoatly/lifti

Repository files navigation

Build Status

LIFTI

A lightweight full text indexer for .NET

Key features:

Getting started

📖 Read the documentation - there's lots of useful information and examples there, along with some getting started guides.

🧑‍💻 Check out some sample code - the repo contains examples that can be run as a console application.

🤹‍♀️ Use LIFTI in a Blazor app - try out various queries against Wikipedia content

Support

If you find LIFTI useful, why not buy me a coffee to power the development work?

buymeacoffee

Contribute

It would be great to have more people contributing to LIFTI - how can you help?

  • Create issues for bugs you find - level 1
  • Create feature suggestions - level 2
  • Create pull requests for documentation changes - level 3
  • Create pull requests for bug fixes or features - boss level

Documentation contributions

  1. Install hugo-extended, e.g. by using winget install Hugo.Hugo.Extended on Windows.
  2. Fork the LIFTI repo and clone your fork locally
  3. Initialize the docsy theme git submodule using git submodule update --recursive --init
  4. Edit the documentation
  5. Test the site locally by running hugo server from the docs folder
  6. Create a pull request for your changes