https://github.com/kong/insomnia-docs
This repository houses all Insomnia documentation.
https://github.com/kong/insomnia-docs
Last synced: 5 months ago
JSON representation
This repository houses all Insomnia documentation.
- Host: GitHub
- URL: https://github.com/kong/insomnia-docs
- Owner: Kong
- Created: 2021-08-12T16:09:04.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-05-08T06:02:39.000Z (5 months ago)
- Last Synced: 2025-05-08T22:06:59.421Z (5 months ago)
- Language: JavaScript
- Homepage: https://docs.insomnia.rest
- Size: 29 MB
- Stars: 36
- Watchers: 10
- Forks: 70
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Insomnia Documentation
Welcome to the open-source Insomnia documentation repository. Find the Insomnia documentation site at [docs.insomnia.rest](https://docs.insomnia.rest/).
Please refer to our [Contributing Guidelines](/CONTRIBUTING.md).
## Run locally
1. Clone the repository.
2. Install [Ruby](https://www.ruby-lang.org/en/) and [Bundler](https://bundler.io/).
3. Run `cd docs`.
4. Run `bundle install`.
5. Run `bundle exec jekyll serve`.
6. Browse to .
## Run with Docker
1. Clone the repository.
2. Install [Docker](https://docs.docker.com/get-docker/).
3. Run `make build` or `docker build --tag insomnia-docs:latest .`.
4. Run `make run` or `docker run --rm -it -p 4000:4000 -v ${PWD}/docs:/docs insomnia-docs:latest`.
5. Browse to .
## Run with nix
1. Clone the repository.
2. Install [Nix](https://nixos.org/).
3. `cd docs`
4. `nix-shell`
5. `bundle install`
6. `bundle exec jekyll serve -H 0.0.0.0 -P 4000 --watch`