Giter VIP home page Giter VIP logo

gimlet-documentation's Introduction

Gimlet.io

This repo holds the source code of the Gimlet.io website.

Getting started

npm install
cp .env.example .env.local

Next, run the development server:

npm run dev

Finally, open http://localhost:3001 in your browser.

Search index generation

We use Algolia for search.

Automatic index generation

A Github Action runs daily that regenerates the search index from the live gimlet.io site.

Running search index generation locally

First you need to put the Algolia admin keys to the .env.local file. Obtain the admin key from the Gimlet maintainers.

APPLICATION_ID=<APP_ID>
API_KEY=<ADMIN_API_KEY>

Then run the following oneliner:

docker run -it --env-file=.env.local -e "CONFIG=$(cat ./config.json | jq -r tostring)" algolia/docsearch-scraper

If you don't have jq, install it here: install jq, a lightweight command-line JSON processor

License

Content in the src/pages folder are licensed under Apache License 2.0.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.