Skip to content

Commit

Permalink
fix lint, update readme and changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
jozsefsallai committed Oct 5, 2020
1 parent a13d7ff commit ddfdb70
Show file tree
Hide file tree
Showing 5 changed files with 61 additions and 7 deletions.
37 changes: 35 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,42 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]
## 0.4.2 - 2020-10-05
### Added
- Table of Contents in the README
- Notice about the [Insomnia Plugin](https://insomnia.rest/plugins/insomnia-plugin-documenter) by @devhammed

### Changed
- UI/UX: Highlight variables and implement example toggle button (thanks @macjuul)

## 0.4.1 - 2020-08-09
### Fixed
- Rendering error when the example response is empty or null.

## 0.4.0 - 2020-06-30
### Changed
- Node.js example uses now fetch too
- You can now specify multiple example responses with status code support

### Fixed
- Basic HTTP auth header generation (@michaelbaudino)

## 0.3.4 - 2020-05-30
### Changed
- Use short options in curl (@ZeProf2Code)
- Updated dependencies

### Fixed
- Horizontal scrolling in code example

## 0.3.3 - 2020-04-06
### Changed
- Upgraded dependencies to resolve security vulnerabilities

### Fixed
- Add mandatory `Basic ` prefix to `"Authorization"` header (thanks to @michaelbaudino)
- applyEnv regex error (@dingyaguang117)
- Request order (@dingyaguang117)
- applyEnv not replacing in every field (@aravindps)

## 0.3.2 - 2020-01-09
### Added
Expand Down
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,23 @@ Like [Postman Documenter](https://www.getpostman.com/api-documentation-generator
**Demo: https://jozsefsallai.github.io/insomnia-documenter**<br>
**Tutorial and demo video: https://www.youtube.com/watch?v=pq2u3FqVVy8**

## Table of Contents

- [Requirements](#requirements)
- [Getting Started](#getting-started)
- [Using `npx`](#using-npx)
- [By installing the package globally](#by-installing-the-package-globally)
- [Options](#options)
- [Using a GitHub Release](#using-a-github-release)
- [Updating the API](#updating-the-api)
- [Custom Root Paths](#custom-root-paths)
- [Running the Page Locally](#running-the-page-locally)
- [Insomnia Plugin](#insomnia-plugin)
- [Changelog](#changelog)
- [Contribution](#contribution)
- [License](#license)
- [Insomnia Documenter for enterprise](#insomnia-documenter-for-enterprise)

## Requirements
* Node.js (8.x or higher is recommended)
* An exported Insomnia workspace JSON (v4)
Expand Down Expand Up @@ -74,6 +91,10 @@ npx serve

The page will be available at http://localhost:5000.

## Insomnia Plugin

[devhammed](https://github.com/devhammed) has made an awesome Insomnia Plugin that allows you to generate a documentation page directly from Insomnia's interface. **[Get The Plugin](https://insomnia.rest/plugins/insomnia-plugin-documenter)** ([npm](https://www.npmjs.com/package/insomnia-plugin-documenter) - [github](https://github.com/devhammed/insomnia-plugin-documenter))

## Changelog

Please see the [Changelog document](https://github.com/jozsefsallai/insomnia-documenter/blob/master/CHANGELOG.md).
Expand Down Expand Up @@ -128,7 +149,7 @@ npm run test

MIT.

*Note: this project is not affiliated with Insomnia.*
*Note: this project is not affiliated with Kong and/or Insomnia.*

## Insomnia Documenter for enterprise

Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "insomnia-documenter",
"version": "0.4.1",
"version": "0.4.2",
"description": "API documentation generator tool for Insomnia.",
"repository": {
"type": "git",
Expand Down
4 changes: 2 additions & 2 deletions src/lib/formatEnv.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
function formatEnv(variable) {
return variable.replace(/{{\s*([a-zA-Z0-9_]+)\s*}}/g, '<span class="env-variable">$1</span>')
return variable.replace(/{{\s*([a-zA-Z0-9_]+)\s*}}/g, '<span class="env-variable">$1</span>');
}

export default formatEnv;
export default formatEnv;

0 comments on commit ddfdb70

Please sign in to comment.