Skip to content

A simple, lightweight and static websites index page

License

Notifications You must be signed in to change notification settings

GaelGirodon/index

Repository files navigation

Index

release license

A simple, lightweight (~17 KiB gzipped) and static websites index page featuring:

  • A search bar using a fuzzy search algorithm
  • Support for multiple websites indexes
  • Saving of recently visited websites
  • 🇫🇷 French and 🇬🇧 English translations

Use case: create an entrypoint page for personal or company web tools and resources that can be set as a browser home or new tab page.

Install

DOWNLOAD_URL="https://github.com/GaelGirodon/index/releases/latest/download"
curl -sL "$DOWNLOAD_URL/index.tar.gz" | tar xvz
  • Create the configuration file: config.json (schema)
  • Create an index file: index.json (schema)
  • Test the index page with a local web server (e.g. php -S localhost:8080, npx http-server, etc.)
  • Deploy files to a static web server (e.g. GitHub/GitLab Pages, Nginx, etc.)

Usage

  • Select an index to browse using the dropdown
  • Type in the search field to find results
  • Select a result using and keys
  • Open the selected result by pressing the Enter key
    or 🖱️ click on a result to open it

License

Index is licensed under the GNU General Public License.