Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GitBook Http Verb Plugin

npm version Build Status

Add Plugin

book.json

{
    "plugins": ["http-verb"]
}

then run

$ gitbook install

Configure (Optional Step)

book.json

"pluginsConfig": {
    "http-verb":{
        "styles": {
            "get": {
                "background": "#fff"
            }
        },
    }
}

Config Options:

Option Description
styles {object}
default: null
an object map of styles for each http verb. see example above on how to define.

Template


{% httpverb %} /api/users/`id` {% endhttpverb %}

Args

httpverb takes an optional named/unnamed argument:

  • verb (string): the http verb to display . eg. get, put and other http verbs. Default: get

examples:


{% httpverb "post" %} /api/users/`id` {% endhttpverb %}
{% httpverb verb="patch" %} /api/users/`id` {% endhttpverb %}

Sample output

output

Pull requests are welcome

About

No description or website provided.

Topics

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages