From 69ccdebadb732f6e31fc26dcdc42993ff2d8c05d Mon Sep 17 00:00:00 2001 From: guoguangwu Date: Thu, 19 Oct 2023 10:44:17 +0800 Subject: [PATCH] fix: typo Signed-off-by: guoguangwu --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 7b4b0d1..e624016 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ For the record, this documentation is automatically generated by Postmanerator a There are chances that the "out-of-the-box" behavior is not good enough for you. Please consider using the following recommendations and command line options to ensure you get the result you expect. - **Use relevant names and descriptions**: folders and requests names are used to create the structure of the generated documentation. You may want to use relevant headers. Furthermore, feel free to write good descriptions for your folders (documentation sections) and requests, as they will be rendered. You may be interested to know that the `default` theme will parse any [Markdown](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) content found in descriptions. -- **Use saved responses**: all saved request's responses are rendered in the `default` theme. You may want to use them to show different potential responses to your users, like a "successfull" response or an "invalid data error" response. +- **Use saved responses**: all saved request's responses are rendered in the `default` theme. You may want to use them to show different potential responses to your users, like a "successful" response or an "invalid data error" response. ### Provide a collection file @@ -55,7 +55,7 @@ By default, Postmanerator will print the generated output to the standard output ### Prevent arbitrary request/response headers to be rendered -Maybe they are some request/response headers you don't want to see in your documentation. You can prevent Postmanerator to render them by providing comma seperated lists of headers to the following options: +Maybe they are some request/response headers you don't want to see in your documentation. You can prevent Postmanerator to render them by providing comma separated lists of headers to the following options: ``` -ignored-request-headers="Content-Type" @@ -86,7 +86,7 @@ function populateNewAPIStructures() { The `/*[[start postmanerator]]*/` and `/*[[end postmanerator]]*/` delimiters are important, Postmanerator will search for these delimiters to identify the portion of Javascript it needs to interpret. -The name of the function `populateNewAPIStructures` is also important as Postmanerator will execute this exact function. You can define as many of these code snippets as you need, even in multiple independant requests. +The name of the function `populateNewAPIStructures` is also important as Postmanerator will execute this exact function. You can define as many of these code snippets as you need, even in multiple independent requests. When Postmanerator is done executing all the snippets, it will look for defined objects in the `APIStructures` global variable and make these structures definitions available for the theme. @@ -198,7 +198,7 @@ Alternatively, you can generate a HTTP snippet from a request: #### Inline some content -Let's assume you are creating a HTML theme, at some point you may want to use libraries downloaded from some CDN like `highlightjs` or `jquery`. If so, it is also possible that you want your generated documentation to be fully functionnal even without an internet connexion. +Let's assume you are creating a HTML theme, at some point you may want to use libraries downloaded from some CDN like `highlightjs` or `jquery`. If so, it is also possible that you want your generated documentation to be fully functional even without an internet connexion. To help you with that, Postmanerator can download some content on the web, and inline it in your template on the fly. Consider the following example: