From 74bc7f1ac82327f3efff7b5c075bd357883e521b Mon Sep 17 00:00:00 2001 From: shalvah Date: Wed, 17 Jun 2020 17:51:07 +0100 Subject: [PATCH] Add example docs --- docs/css/highlight-atelier-cave-light.css | 85 ++ docs/css/highlight-darcula.css | 74 ++ docs/css/highlight-monokai-sublime.css | 83 ++ docs/css/highlight-monokai.css | 71 ++ docs/css/highlight-vs2015.css | 115 +++ docs/css/print.css | 393 +++++++++ docs/css/style.css | 985 ++++++++++++++++++++++ docs/images/logo.png | Bin 0 -> 5113 bytes docs/images/navbar.png | Bin 0 -> 96 bytes docs/index.html | 286 +++++++ docs/js/all.js | 6 + docs/js/highlight.pack.js | 2 + 12 files changed, 2100 insertions(+) create mode 100644 docs/css/highlight-atelier-cave-light.css create mode 100644 docs/css/highlight-darcula.css create mode 100644 docs/css/highlight-monokai-sublime.css create mode 100644 docs/css/highlight-monokai.css create mode 100644 docs/css/highlight-vs2015.css create mode 100644 docs/css/print.css create mode 100644 docs/css/style.css create mode 100644 docs/images/logo.png create mode 100644 docs/images/navbar.png create mode 100644 docs/index.html create mode 100644 docs/js/all.js create mode 100644 docs/js/highlight.pack.js diff --git a/docs/css/highlight-atelier-cave-light.css b/docs/css/highlight-atelier-cave-light.css new file mode 100644 index 0000000..b419f9f --- /dev/null +++ b/docs/css/highlight-atelier-cave-light.css @@ -0,0 +1,85 @@ +/* Base16 Atelier Cave Light - Theme */ +/* by Bram de Haan (http://atelierbram.github.io/syntax-highlighting/atelier-schemes/cave) */ +/* Original Base16 color scheme by Chris Kempson (https://github.com/chriskempson/base16) */ + +/* Atelier-Cave Comment */ +.hljs-comment, +.hljs-quote { + color: #655f6d; +} + +/* Atelier-Cave Red */ +.hljs-variable, +.hljs-template-variable, +.hljs-attribute, +.hljs-tag, +.hljs-name, +.hljs-regexp, +.hljs-link, +.hljs-name, +.hljs-name, +.hljs-selector-id, +.hljs-selector-class { + color: #be4678; +} + +/* Atelier-Cave Orange */ +.hljs-number, +.hljs-meta, +.hljs-built_in, +.hljs-builtin-name, +.hljs-literal, +.hljs-type, +.hljs-params { + color: #aa573c; +} + +/* Atelier-Cave Green */ +.hljs-string, +.hljs-symbol, +.hljs-bullet { + color: #2a9292; +} + +/* Atelier-Cave Blue */ +.hljs-title, +.hljs-section { + color: #576ddb; +} + +/* Atelier-Cave Purple */ +.hljs-keyword, +.hljs-selector-tag { + color: #955ae7; +} + +.hljs-deletion, +.hljs-addition { + color: #19171c; + display: inline-block; + width: 100%; +} + +.hljs-deletion { + background-color: #be4678; +} + +.hljs-addition { + background-color: #2a9292; +} + +.hljs { + display: block; + overflow-x: auto; + background: #efecf4; + color: #585260; + padding: 0.5em; +} + +.hljs-emphasis { + font-style: italic; +} + +.hljs-strong { + font-weight: bold; +} diff --git a/docs/css/highlight-darcula.css b/docs/css/highlight-darcula.css new file mode 100644 index 0000000..4c734f1 --- /dev/null +++ b/docs/css/highlight-darcula.css @@ -0,0 +1,74 @@ +/* + +Darcula color scheme from the JetBrains family of IDEs + +*/ + + +.hljs { + display: block; + overflow-x: auto; + padding: 0.5em; + background: #2b2b2b; + color: #bababa; +} + +.hljs-strong, +.hljs-emphasis { + color: #a8a8a2; +} + +.hljs-bullet, +.hljs-quote, +.hljs-link, +.hljs-number, +.hljs-regexp, +.hljs-literal { + color: #6896ba; +} + +.hljs-code, +.hljs-selector-class { + color: #a6e22e; +} + +.hljs-emphasis { + font-style: italic; +} + +.hljs-keyword, +.hljs-selector-tag, +.hljs-section, +.hljs-attribute, +.hljs-name, +.hljs-variable { + color: #cb7832; +} + +.hljs-params { + color: #b9b9b9; +} + +.hljs-string { + color: #6a8759; +} + +.hljs-subst, +.hljs-type, +.hljs-built_in, +.hljs-builtin-name, +.hljs-symbol, +.hljs-selector-id, +.hljs-selector-attr, +.hljs-selector-pseudo, +.hljs-template-tag, +.hljs-template-variable, +.hljs-addition { + color: #e0c46c; +} + +.hljs-comment, +.hljs-deletion, +.hljs-meta { + color: #7f7f7f; +} diff --git a/docs/css/highlight-monokai-sublime.css b/docs/css/highlight-monokai-sublime.css new file mode 100644 index 0000000..2864170 --- /dev/null +++ b/docs/css/highlight-monokai-sublime.css @@ -0,0 +1,83 @@ +/* + +Monokai Sublime style. Derived from Monokai by noformnocontent http://nn.mit-license.org/ + +*/ + +.hljs { + display: block; + overflow-x: auto; + padding: 0.5em; + background: #23241f; +} + +.hljs, +.hljs-tag, +.hljs-subst { + color: #f8f8f2; +} + +.hljs-strong, +.hljs-emphasis { + color: #a8a8a2; +} + +.hljs-bullet, +.hljs-quote, +.hljs-number, +.hljs-regexp, +.hljs-literal, +.hljs-link { + color: #ae81ff; +} + +.hljs-code, +.hljs-title, +.hljs-section, +.hljs-selector-class { + color: #a6e22e; +} + +.hljs-strong { + font-weight: bold; +} + +.hljs-emphasis { + font-style: italic; +} + +.hljs-keyword, +.hljs-selector-tag, +.hljs-name, +.hljs-attr { + color: #f92672; +} + +.hljs-symbol, +.hljs-attribute { + color: #66d9ef; +} + +.hljs-params, +.hljs-class .hljs-title { + color: #f8f8f2; +} + +.hljs-string, +.hljs-type, +.hljs-built_in, +.hljs-builtin-name, +.hljs-selector-id, +.hljs-selector-attr, +.hljs-selector-pseudo, +.hljs-addition, +.hljs-variable, +.hljs-template-variable { + color: #e6db74; +} + +.hljs-comment, +.hljs-deletion, +.hljs-meta { + color: #75715e; +} diff --git a/docs/css/highlight-monokai.css b/docs/css/highlight-monokai.css new file mode 100644 index 0000000..af24834 --- /dev/null +++ b/docs/css/highlight-monokai.css @@ -0,0 +1,71 @@ +/* +Monokai style - ported by Luigi Maselli - http://grigio.org +*/ + +.hljs { + display: block; + overflow-x: auto; + padding: 0.5em; + background: #272822; + color: #ddd; +} + +.hljs-tag, +.hljs-keyword, +.hljs-selector-tag, +.hljs-literal, +.hljs-strong, +.hljs-name { + color: #f92672; +} + +.hljs-code { + color: #66d9ef; +} + +.hljs-class .hljs-title { + color: white; +} + +.hljs-attribute, +.hljs-symbol, +.hljs-regexp, +.hljs-link { + color: #bf79db; +} + +.hljs-string, +.hljs-bullet, +.hljs-subst, +.hljs-title, +.hljs-section, +.hljs-emphasis, +.hljs-type, +.hljs-built_in, +.hljs-builtin-name, +.hljs-selector-attr, +.hljs-selector-pseudo, +.hljs-addition, +.hljs-variable, +.hljs-template-tag, +.hljs-template-variable { + color: #a6e22e; +} + +.hljs-comment, +.hljs-quote, +.hljs-deletion, +.hljs-meta { + color: #75715e; +} + +.hljs-keyword, +.hljs-selector-tag, +.hljs-literal, +.hljs-doctag, +.hljs-title, +.hljs-section, +.hljs-type, +.hljs-selector-id { + font-weight: bold; +} diff --git a/docs/css/highlight-vs2015.css b/docs/css/highlight-vs2015.css new file mode 100644 index 0000000..d1d9be3 --- /dev/null +++ b/docs/css/highlight-vs2015.css @@ -0,0 +1,115 @@ +/* + * Visual Studio 2015 dark style + * Author: Nicolas LLOBERA + */ + +.hljs { + display: block; + overflow-x: auto; + padding: 0.5em; + background: #1E1E1E; + color: #DCDCDC; +} + +.hljs-keyword, +.hljs-literal, +.hljs-symbol, +.hljs-name { + color: #569CD6; +} +.hljs-link { + color: #569CD6; + text-decoration: underline; +} + +.hljs-built_in, +.hljs-type { + color: #4EC9B0; +} + +.hljs-number, +.hljs-class { + color: #B8D7A3; +} + +.hljs-string, +.hljs-meta-string { + color: #D69D85; +} + +.hljs-regexp, +.hljs-template-tag { + color: #9A5334; +} + +.hljs-subst, +.hljs-function, +.hljs-title, +.hljs-params, +.hljs-formula { + color: #DCDCDC; +} + +.hljs-comment, +.hljs-quote { + color: #57A64A; + font-style: italic; +} + +.hljs-doctag { + color: #608B4E; +} + +.hljs-meta, +.hljs-meta-keyword, +.hljs-tag { + color: #9B9B9B; +} + +.hljs-variable, +.hljs-template-variable { + color: #BD63C5; +} + +.hljs-attr, +.hljs-attribute, +.hljs-builtin-name { + color: #9CDCFE; +} + +.hljs-section { + color: gold; +} + +.hljs-emphasis { + font-style: italic; +} + +.hljs-strong { + font-weight: bold; +} + +/*.hljs-code { + font-family:'Monospace'; +}*/ + +.hljs-bullet, +.hljs-selector-tag, +.hljs-selector-id, +.hljs-selector-class, +.hljs-selector-attr, +.hljs-selector-pseudo { + color: #D7BA7D; +} + +.hljs-addition { + background-color: #144212; + display: inline-block; + width: 100%; +} + +.hljs-deletion { + background-color: #600; + display: inline-block; + width: 100%; +} diff --git a/docs/css/print.css b/docs/css/print.css new file mode 100644 index 0000000..0e1f323 --- /dev/null +++ b/docs/css/print.css @@ -0,0 +1,393 @@ +/* Copied from https://github.com/slatedocs/slate/blob/c4b4c0b8f83e891ca9fab6bbe9a1a88d5fe41292/stylesheets/print.css and unminified */ +/*! normalize.css v3.0.2 | MIT License | git.io/normalize */ + +html { + font-family: sans-serif; + -ms-text-size-adjust: 100%; + -webkit-text-size-adjust: 100% +} + +body { + margin: 0 +} + +article, +aside, +details, +figcaption, +figure, +footer, +header, +hgroup, +main, +menu, +nav, +section, +summary { + display: block +} + +audio, +canvas, +progress, +video { + display: inline-block; + vertical-align: baseline +} + +audio:not([controls]) { + display: none; + height: 0 +} + +[hidden], +template { + display: none +} + +a { + background-color: transparent +} + +a:active, +a:hover { + outline: 0 +} + +abbr[title] { + border-bottom: 1px dotted +} + +b, +strong { + font-weight: bold +} + +dfn { + font-style: italic +} + +h1 { + font-size: 2em; + margin: 0.67em 0 +} + +mark { + background: #ff0; + color: #000 +} + +small { + font-size: 80% +} + +sub, +sup { + font-size: 75%; + line-height: 0; + position: relative; + vertical-align: baseline +} + +sup { + top: -0.5em +} + +sub { + bottom: -0.25em +} + +img { + border: 0 +} + +svg:not(:root) { + overflow: hidden +} + +figure { + margin: 1em 40px +} + +hr { + box-sizing: content-box; + height: 0 +} + +pre { + overflow: auto +} + +code, +kbd, +pre, +samp { + font-family: monospace, monospace; + font-size: 1em +} + +button, +input, +optgroup, +select, +textarea { + color: inherit; + font: inherit; + margin: 0 +} + +button { + overflow: visible +} + +button, +select { + text-transform: none +} + +button, +html input[type="button"], +input[type="reset"], +input[type="submit"] { + -webkit-appearance: button; + cursor: pointer +} + +button[disabled], +html input[disabled] { + cursor: default +} + +button::-moz-focus-inner, +input::-moz-focus-inner { + border: 0; + padding: 0 +} + +input { + line-height: normal +} + +input[type="checkbox"], +input[type="radio"] { + box-sizing: border-box; + padding: 0 +} + +input[type="number"]::-webkit-inner-spin-button, +input[type="number"]::-webkit-outer-spin-button { + height: auto +} + +input[type="search"] { + -webkit-appearance: textfield; + box-sizing: content-box +} + +input[type="search"]::-webkit-search-cancel-button, +input[type="search"]::-webkit-search-decoration { + -webkit-appearance: none +} + +fieldset { + border: 1px solid #c0c0c0; + margin: 0 2px; + padding: 0.35em 0.625em 0.75em +} + +legend { + border: 0; + padding: 0 +} + +textarea { + overflow: auto +} + +optgroup { + font-weight: bold +} + +table { + border-collapse: collapse; + border-spacing: 0 +} + +td, +th { + padding: 0 +} + +.content h1, +.content h2, +.content h3, +.content h4, +body { + font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol"; + font-size: 14px +} + +.content h1, +.content h2, +.content h3, +.content h4 { + font-weight: bold +} + +.content pre, +.content code { + font-family: Consolas, Menlo, Monaco, "Lucida Console", "Liberation Mono", "DejaVu Sans Mono", "Bitstream Vera Sans Mono", "Courier New", monospace, serif; + font-size: 12px; + line-height: 1.5 +} + +.content pre, +.content code { + word-break: break-all; + -webkit-hyphens: auto; + -ms-hyphens: auto; + hyphens: auto +} + +@font-face { + font-family: 'slate'; + src: url(../fonts/slate.eot?-syv14m); + src: url(../fonts/slate.eot?#iefix-syv14m) format("embedded-opentype"), url(../fonts/slate.woff2?-syv14m) format("woff2"), url(../fonts/slate.woff?-syv14m) format("woff"), url(../fonts/slate.ttf?-syv14m) format("truetype"), url(../fonts/slate.svg?-syv14m#slate) format("svg"); + font-weight: normal; + font-style: normal +} + +.content aside.warning:before, +.content aside.notice:before, +.content aside.success:before { + font-family: 'slate'; + speak: none; + font-style: normal; + font-weight: normal; + font-variant: normal; + text-transform: none; + line-height: 1 +} + +.content aside.warning:before { + content: "\e600" +} + +.content aside.notice:before { + content: "\e602" +} + +.content aside.success:before { + content: "\e606" +} + +.tocify, +.toc-footer, +.lang-selector, +.search, +#nav-button { + display: none +} + +.tocify-wrapper>img { + margin: 0 auto; + display: block +} + +.content { + font-size: 12px +} + +.content pre, +.content code { + border: 1px solid #999; + border-radius: 5px; + font-size: 0.8em +} + +.content pre code { + border: 0 +} + +.content pre { + padding: 1.3em +} + +.content code { + padding: 0.2em +} + +.content table { + border: 1px solid #999 +} + +.content table tr { + border-bottom: 1px solid #999 +} + +.content table td, +.content table th { + padding: 0.7em +} + +.content p { + line-height: 1.5 +} + +.content a { + text-decoration: none; + color: #000 +} + +.content h1 { + font-size: 2.5em; + padding-top: 0.5em; + padding-bottom: 0.5em; + margin-top: 1em; + margin-bottom: 21px; + border: 2px solid #ccc; + border-width: 2px 0; + text-align: center +} + +.content h2 { + font-size: 1.8em; + margin-top: 2em; + border-top: 2px solid #ccc; + padding-top: 0.8em +} + +.content h1+h2, +.content h1+div+h2 { + border-top: none; + padding-top: 0; + margin-top: 0 +} + +.content h3, +.content h4 { + font-size: 0.8em; + margin-top: 1.5em; + margin-bottom: 0.8em; + text-transform: uppercase +} + +.content h5, +.content h6 { + text-transform: uppercase +} + +.content aside { + padding: 1em; + border: 1px solid #ccc; + border-radius: 5px; + margin-top: 1.5em; + margin-bottom: 1.5em; + line-height: 1.6 +} + +.content aside:before { + vertical-align: middle; + padding-right: 0.5em; + font-size: 14px +} \ No newline at end of file diff --git a/docs/css/style.css b/docs/css/style.css new file mode 100644 index 0000000..99bc39a --- /dev/null +++ b/docs/css/style.css @@ -0,0 +1,985 @@ +/*! normalize.css v3.0.2 | MIT License | git.io/normalize */ + +html { + font-family: 'PT Sans', sans-serif; + font-size: 1.2em; + -ms-text-size-adjust: 100%; + -webkit-text-size-adjust: 100% +} + +body { + margin: 0 +} + +article, +aside, +details, +figcaption, +figure, +footer, +header, +hgroup, +main, +menu, +nav, +section, +summary { + display: block +} + +audio, +canvas, +progress, +video { + display: inline-block; + vertical-align: baseline +} + +audio:not([controls]) { + display: none; + height: 0 +} + +[hidden], +template { + display: none +} + +a { + background-color: transparent +} + +a:active, +a:hover { + outline: 0 +} + +abbr[title] { + border-bottom: 1px dotted +} + +b, +strong { + font-weight: 700 +} + +dfn { + font-style: italic +} + +h1 { + font-size: 2em; + margin: .67em 0 +} + +mark { + background: #ff0; + color: #000 +} + +small { + font-size: 80% +} + +sub, +sup { + font-size: 75%; + line-height: 0; + position: relative; + vertical-align: baseline +} + +sup { + top: -.5em +} + +sub { + bottom: -.25em +} + +img { + border: 0 +} + +svg:not(:root) { + overflow: hidden +} + +figure { + margin: 1em 40px +} + +hr { + box-sizing: content-box; + height: 0 +} + +pre { + overflow: auto +} + +code, +kbd, +pre, +samp { + font-family: monospace, monospace; + font-size: 1em +} + +button, +input, +optgroup, +select, +textarea { + color: inherit; + font: inherit; + margin: 0 +} + +button { + overflow: visible +} + +button, +select { + text-transform: none +} + +button, +html input[type=button], +input[type=reset], +input[type=submit] { + -webkit-appearance: button; + cursor: pointer +} + +button[disabled], +html input[disabled] { + cursor: default +} + +button::-moz-focus-inner, +input::-moz-focus-inner { + border: 0; + padding: 0 +} + +input { + line-height: normal +} + +input[type=checkbox], +input[type=radio] { + box-sizing: border-box; + padding: 0 +} + +input[type=number]::-webkit-inner-spin-button, +input[type=number]::-webkit-outer-spin-button { + height: auto +} + +input[type=search] { + -webkit-appearance: textfield; + box-sizing: content-box +} + +input[type=search]::-webkit-search-cancel-button, +input[type=search]::-webkit-search-decoration { + -webkit-appearance: none +} + +fieldset { + border: 1px solid silver; + margin: 0 2px; + padding: .35em .625em .75em +} + +legend { + border: 0; + padding: 0 +} + +textarea { + overflow: auto +} + +optgroup { + font-weight: 700 +} + +table { + border-collapse: collapse; + border-spacing: 0 +} + +td, +th { + padding: 0 +} + +.content h1, +.content h2, +.content h3, +.content h4, +.content h5, +.content h6, +body, +html { + font-family: 'PT Sans', Helvetica Neue, Helvetica, Arial, Microsoft Yahei, 微软雅黑, STXihei, 华文细黑, sans-serif; + font-size: 15px; +} + +.content h1, +.content h2, +.content h3, +.content h4, +.content h5, +.content h6 { + font-weight: 700 +} + +.content code, +.content pre { + font-family: Consolas, Menlo, Monaco, Lucida Console, Liberation Mono, DejaVu Sans Mono, Bitstream Vera Sans Mono, Courier New, monospace, serif; + font-size: 12px; + line-height: 1.5 +} + +.content code { + word-break: break-all; + word-break: break-word; + -webkit-hyphens: auto; + -ms-hyphens: auto; + hyphens: auto +} + +.content aside.notice:before, +.content aside.success:before, +.content aside.warning:before, +.tocify-wrapper>.search:before { + font-family: 'PT Sans', sans-serif; + speak: none; + font-style: normal; + font-variant: normal; + text-transform: none; + line-height: 1 +} + +.content aside.warning:before { + content: "✋" +} + +.content aside.notice:before { + content: "ℹ" +} + +.content aside.success:before { + content: "✅" +} + +.tocify-wrapper>.search:before { + content: "🔎" +} + +.highlight .c, +.highlight .c1, +.highlight .cm, +.highlight .cs { + color: #909090 +} + +.highlight, +.highlight .w { + background-color: #292929 +} + +.hljs { + display: block; + overflow-x: auto; + padding: .5em; + background: #23241f +} + +.hljs, +.hljs-subst, +.hljs-tag { + color: #f8f8f2 +} + +.hljs-emphasis, +.hljs-strong { + color: #a8a8a2 +} + +.hljs-bullet, +.hljs-link, +.hljs-literal, +.hljs-number, +.hljs-quote, +.hljs-regexp { + color: #ae81ff +} + +.hljs-code, +.hljs-section, +.hljs-selector-class, +.hljs-title { + color: #a6e22e +} + +.hljs-strong { + font-weight: 700 +} + +.hljs-emphasis { + font-style: italic +} + +.hljs-attr, +.hljs-keyword, +.hljs-name, +.hljs-selector-tag { + color: #f92672 +} + +.hljs-attribute, +.hljs-symbol { + color: #66d9ef +} + +.hljs-class .hljs-title, +.hljs-params { + color: #f8f8f2 +} + +.hljs-addition, +.hljs-built_in, +.hljs-builtin-name, +.hljs-selector-attr, +.hljs-selector-id, +.hljs-selector-pseudo, +.hljs-string, +.hljs-template-variable, +.hljs-type, +.hljs-variable { + color: #e6db74 +} + +.hljs-comment, +.hljs-deletion, +.hljs-meta { + color: #75715e +} + +body, +html { + color: #333; + padding: 0; + margin: 0; + -webkit-font-smoothing: antialiased; + -moz-osx-font-smoothing: grayscale; + background-color: whitesmoke; + height: 100%; + -webkit-text-size-adjust: none +} + +#toc>ul>li>a>span { + float: right; + background-color: #2484ff; + border-radius: 40px; + width: 20px +} + +.tocify-wrapper { + transition: left .3s ease-in-out; + overflow-y: auto; + overflow-x: hidden; + position: fixed; + z-index: 30; + top: 0; + left: 0; + bottom: 0; + width: 230px; + background-color: #393939; + font-size: 13px; + font-weight: 700 +} + +.tocify-wrapper .lang-selector { + display: none +} + +.tocify-wrapper .lang-selector a { + padding-top: .5em; + padding-bottom: .5em +} + +.tocify-wrapper>img { + display: block +} + +.tocify-wrapper>.search { + position: relative +} + +.tocify-wrapper>.search input { + background: #393939; + border-width: 0 0 1px; + border-color: #666; + padding: 6px 0 6px 20px; + box-sizing: border-box; + margin: 10px 15px; + width: 200px; + outline: none; + color: #fff; + border-radius: 0 +} + +.tocify-wrapper>.search:before { + position: absolute; + top: 17px; + left: 15px; + color: #fff +} + +.tocify-wrapper img+.tocify { + margin-top: 20px +} + +.tocify-wrapper .search-results { + margin-top: 0; + box-sizing: border-box; + height: 0; + overflow-y: auto; + overflow-x: hidden; + transition-property: height, margin; + transition-duration: .18s; + transition-timing-function: ease-in-out; + background: linear-gradient(180deg, rgba(0, 0, 0, .2), transparent 8px), linear-gradient(0deg, rgba(0, 0, 0, .2), transparent 8px), linear-gradient(180deg, #000, transparent 1.5px), linear-gradient(0deg, #939393, hsla(0, 0%, 58%, 0) 1.5px), #262626 +} + +.tocify-wrapper .search-results.visible { + height: 30%; + margin-bottom: 1em +} + +.tocify-wrapper .search-results li { + margin: 1em 15px; + line-height: 1 +} + +.tocify-wrapper .search-results a { + color: #fff; + text-decoration: none +} + +.tocify-wrapper .search-results a:hover { + text-decoration: underline +} + +.tocify-wrapper .toc-footer li, +.tocify-wrapper .tocify-item>a { + padding: 0 15px; + display: block; + overflow-x: hidden; + white-space: nowrap; + text-overflow: ellipsis +} + +.tocify-wrapper li, +.tocify-wrapper ul { + list-style: none; + margin: 0; + padding: 0; + line-height: 28px +} + +.tocify-wrapper li { + color: #fff; + transition-property: background; + transition-timing-function: linear; + transition-duration: .23s +} + +.tocify-wrapper .tocify-focus { + box-shadow: 0 1px 0 #000; + background-color: #2467af; + color: #fff +} + +.tocify-wrapper .tocify-subheader { + display: none; + background-color: #262626; + font-weight: 500; + background: linear-gradient(180deg, rgba(0, 0, 0, .2), transparent 8px), linear-gradient(0deg, rgba(0, 0, 0, .2), transparent 8px), linear-gradient(180deg, #000, transparent 1.5px), linear-gradient(0deg, #939393, hsla(0, 0%, 58%, 0) 1.5px), #262626 +} + +.tocify-wrapper .tocify-subheader .tocify-item>a { + padding-left: 25px; + font-size: 12px +} + +.tocify-wrapper .tocify-subheader>li:last-child { + box-shadow: none +} + +.tocify-wrapper .toc-footer { + padding: 1em 0; + margin-top: 1em; + border-top: 1px dashed #666 +} + +.tocify-wrapper .toc-footer a, +.tocify-wrapper .toc-footer li { + color: #fff; + text-decoration: none +} + +.tocify-wrapper .toc-footer a:hover { + text-decoration: underline +} + +.tocify-wrapper .toc-footer li { + font-size: .8em; + line-height: 1.7; + text-decoration: none +} + +#nav-button { + padding: 0 1.5em 5em 0; + display: none; + position: fixed; + top: 0; + left: 0; + z-index: 100; + color: #000; + text-decoration: none; + font-weight: 700; + opacity: .7; + line-height: 16px; + transition: left .3s ease-in-out +} + +#nav-button span { + display: block; + padding: 6px; + background-color: rgba(234, 242, 246, .7); + -webkit-transform-origin: 0 0; + transform-origin: 0 0; + -webkit-transform: rotate(-90deg) translate(-100%); + transform: rotate(-90deg) translate(-100%); + border-radius: 0 0 0 5px +} + +#nav-button img { + height: 16px; + vertical-align: bottom +} + +#nav-button:hover { + opacity: 1 +} + +#nav-button.open { + left: 230px +} + +.page-wrapper { + margin-left: 230px; + position: relative; + z-index: 10; + background-color: #eaf2f6; + min-height: 100%; + padding-bottom: 1px +} + +.page-wrapper .dark-box { + width: 50%; + background-color: #393939; + position: absolute; + right: 0; + top: 0; + bottom: 0 +} + +.page-wrapper .lang-selector { + position: fixed; + z-index: 50; + border-bottom: 5px solid #393939 +} + +.lang-selector { + background-color: #222; + width: 100%; + font-weight: 700 +} + +.lang-selector a { + display: block; + float: left; + color: #fff; + text-decoration: none; + padding: 0 10px; + line-height: 30px; + outline: 0 +} + +.lang-selector a:active, +.lang-selector a:focus { + background-color: #111; + color: #fff +} + +.lang-selector a.active { + background-color: #393939; + color: #fff +} + +.lang-selector:after { + content: ''; + clear: both; + display: block +} + +.content { + position: relative; + z-index: 30 +} + +.content:after { + content: ''; + display: block; + clear: both +} + +.content>aside, +.content>dl, +.content>h1, +.content>h2, +.content>h3, +.content>h4, +.content>h5, +.content>h6, +.content>ol, +.content>p, +.content>table, +.content>ul { + margin-right: 50%; + padding: 0 28px; + box-sizing: border-box; + display: block; + text-shadow: 0 1px 0 #fff +} + +.content>ol, +.content>ul { + padding-left: 43px +} + +.content>div, +.content>h1, +.content>h2 { + clear: both +} + +.content h1 { + font-size: 30px; + padding-top: .5em; + padding-bottom: .5em; + border-bottom: 1px solid #ccc; + margin-bottom: 21px; + margin-top: 2em; + border-top: 1px solid #ddd; + background-image: linear-gradient(180deg, #fff, #f9f9f9) +} + +.content div:first-child+h1, +.content h1:first-child { + border-top-width: 0; + margin-top: 0 +} + +.content h2 { + font-size: 20px; + margin-top: 4em; + margin-bottom: 0; + border-top: 1px solid #ccc; + padding-top: 1.2em; + padding-bottom: 1.2em; + background-image: linear-gradient(180deg, hsla(0, 0%, 100%, .4), hsla(0, 0%, 100%, 0)) +} + +.content h1+div+h2, +.content h1+h2 { + margin-top: -21px; + border-top: none +} + +.content h3, +.content h4, +.content h5, +.content h6 { + font-size: 15px; + margin-top: 2.5em; + margin-bottom: .8em +} + +.content h4, +.content h5, +.content h6 { + font-size: 10px +} + +.content hr { + margin: 2em 0; + border-top: 2px solid #393939; + border-bottom: 2px solid #eaf2f6 +} + +.content table { + margin-bottom: 1em; + overflow: auto +} + +.content table td, +.content table th { + text-align: left; + vertical-align: top; + line-height: 1.6 +} + +.content table th { + padding: 5px 10px; + border-bottom: 1px solid #ccc; + vertical-align: bottom +} + +.content table td { + padding: 10px +} + +.content table tr:last-child { + border-bottom: 1px solid #ccc +} + +.content table tr:nth-child(odd)>td { + background-color: #ebf3f6 +} + +.content table tr:nth-child(even)>td { + background-color: #ebf2f6 +} + +.content dt { + font-weight: 700 +} + +.content dd { + margin-left: 15px +} + +.content dd, +.content dt, +.content li, +.content p { + line-height: 1.6; + margin-top: 0 +} + +.content img { + max-width: 100% +} + +.content code { + background-color: rgba(0, 0, 0, .05); + padding: 3px; + border-radius: 3px +} + +.content pre>code { + background-color: transparent; + padding: 0 +} + +.content aside { + padding-top: 1em; + padding-bottom: 1em; + text-shadow: 0 1px 0 #a0c6da; + margin-top: 1.5em; + margin-bottom: 1.5em; + background: #8fbcd4; + line-height: 1.6 +} + +.content aside.warning { + background-color: #c97a7e; + text-shadow: 0 1px 0 #d18e91 +} + +.content aside.success { + background-color: #6ac174; + text-shadow: 0 1px 0 #80ca89 +} + +.content aside:before { + vertical-align: middle; + padding-right: .5em; + font-size: 14px +} + +.content .search-highlight { + padding: 2px; + margin: -2px; + border-radius: 4px; + border: 1px solid #f7e633; + text-shadow: 1px 1px 0 #666; + background: linear-gradient(to top left, #f7e633, #f1d32f) +} + +.content blockquote, +.content pre { + background-color: #292929; + color: #fff; + padding: 2em 28px; + margin: 0; + width: 50%; + float: right; + clear: right; + box-sizing: border-box; + text-shadow: 0 1px 2px rgba(0, 0, 0, .4) +} + +.content blockquote>p, +.content pre>p { + margin: 0 +} + +.content blockquote a, +.content pre a { + color: #fff; + text-decoration: none; + border-bottom: 1px dashed #ccc +} + +.content blockquote>p { + background-color: #1c1c1c; + border-radius: 5px; + padding: 13px; + color: #ccc; + border-top: 1px solid #000; + border-bottom: 1px solid #404040 +} + +@media (max-width:930px) { + .tocify-wrapper { + left: -230px + } + .tocify-wrapper.open { + left: 0 + } + .page-wrapper { + margin-left: 0 + } + #nav-button { + display: block + } + .tocify-wrapper .tocify-item>a { + padding-top: .3em; + padding-bottom: .3em + } +} + +@media (max-width:700px) { + .dark-box { + display: none + } + .tocify-wrapper .lang-selector { + display: block + } + .page-wrapper .lang-selector { + display: none + } + .content aside, + .content dl, + .content h1, + .content h2, + .content h3, + .content h4, + .content h5, + .content h6, + .content ol, + .content p, + .content table, + .content ul { + margin-right: 0 + } + .content blockquote, + .content pre { + float: none; + width: auto + } +} + +.badge { + padding: 1px 9px 2px; + white-space: nowrap; + -webkit-border-radius: 9px; + -moz-border-radius: 9px; + border-radius: 9px; + color: #ffffff; +} + +.badge.badge-darkred { + background-color: darkred; +} + +.badge.badge-red { + background-color: red; +} + +.badge.badge-blue { + background-color: blue; +} + +.badge.badge-darkblue { + background-color: darkblue; +} + +.badge.badge-green { + background-color: green; +} + +.badge.badge-darkgreen { + background-color: darkgreen; +} + +.badge.badge-purple { + background-color: purple; +} + +.badge.badge-black { + background-color: black; +} + +.badge.badge-grey { + background-color: grey; +} + +.fancy-heading-panel { + background-color: lightgrey; + border-radius: 5px; + padding-left: 5px !important; + padding-top: 5px !important; + padding-bottom: 5px !important; + margin-left: 25px; + margin-right: 10px; + width: 47%; +} + +@media screen and (max-width: 700px) { + .fancy-heading-panel { + width: 95%; + } + +} \ No newline at end of file diff --git a/docs/images/logo.png b/docs/images/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..1c5dfe5cf504b10cc36a1488fa74d7e8cfdeacd0 GIT binary patch literal 5113 zcmaJ_cT`hbv!|mp>1b#H1wncX5IUh_00E^VAq0q!1W4$JNRuXrNJlzIlPX2&y@S#W zy-5*~E=Um`-p_l#_s6^MtTSiNo;APU%8-T7$G<#Ge3Zi+L)*yB85ZU_PuJB%#?sEvX-APf;OJ8#!sgggNO@hzmWDb5sn z7YxUsgkisZguPHMmuLb4c_l9w7~Bbg1KJ`SkZ1+&?fPbJAkt2O+e8W~3Uz@X9FbZ+ zZU`eEJ!80!6I|AgTS*Zp?*+ajKp}82pcl#+jRkutaR0>%zSMu4MYw@~x!{}>xc`%s zDbxT6!MGuSQo<5Ka8WTaAP6KZCMg91i3tM5Ma9HLL@!^EkeDP`3IrCH2L5@tFQd8H z*@F$$H2%c8+$nH7;&3it5fM*MPhn39VT_xDh?uOb>~9WnaiL2OA*?qV2lEm_V{iV= zpoYN0-HpMB3>{T5iw!W-zEL+2!;Ot zt|-($-dLO=;=lR+pTt;WZx@7!Ap(nWcY|Lx&i>}_P%dDI8v=&IxEW(G&VQexfg=Wo z!8&4GfDj`PkPixjBhkMN{C^>!P_Q-{i-V!z2yHb5?n@3~B+?G73eo_nNouHxYKW?d ziK&BRR3R!5RaJEvF-a8(X^`sQSTzjX9fd&S{>Iw<7pwlS*x$o|a=DDGhHyiAAnY{U zFeu<(MT3$5o{Q?g^8LZu{d+Euf5nPiCL{8@wg0Qtf157n=ePRL;9hS28GQu$a^Br8 z2b-r$Rfd3o)=67U#n@|V)AFimygG|wB2>99z!DJ$?Ii6m5a59t^;SRBed{a+73hCA z@NVScTglP80>9!YEZ#|?J`Ly$T2=~TpJAna6@HRH% zbYMUlyE>5UIh2-s`gG`B?5$hp>gBP#FJ8Qg|405$wGM6LdEZCj<=tKffe*D=*59l3 zmyOo#$aL}3hQnb`%xkmhr#Rl^`g#IiZ>6M42mn@ZAlG7b0S^po4n>)bE|A7(+ppuJ zNEepiG|Sg3 zB-)m&PYD+mRk50%;M?T~4P}mBUNde&8Rp)+q%0xXZ7G)%+*o7$nE#8>Gmt`;Pd?0N zMvV|Up#S+?uQP9~C4H+2%Fo}Z?Box>DoDjKz6+N3-H~}*@!AjY>8DCHXP|q$OyxeZ zontCd*`I7

>jw5zd1UNWF9XmI?HEyrpXC-^)Cz?XePz4~^lk2~+1D&#kn6N%Vl zg-YsK=00bh8Im#L56|N2DTU^B$mz|rLccEjl9MiKvQYcH5%D#XG@tg@#^gZ9s;b=`hA@tgUZpwPbGAc$g8^g?D+!vBcz9bX8&TwQ|UAt~|fC*)iT0OKJusFW&fg3B8%| zaLcsoRjwq-XIyf2mZitE&sq{w@4AmP@ZM=1oR=_K6yUqU5<=+KRJ4nq?n8eBg?*^b zYwtb43jXp>I?;dAtO(S6_DJ%peCtvd!7~%;rqdt}?>L^6(~qy&lU8@=>SGL#dU1TA z&i9-ArVLlILvtF^$eP;Dil0Z5X}t7>fHX~Q^aXFNksTNev%aiUe#R_mPtbUzpzE+w zf!U0b5Y)HYp#_rfvvZoLt?z|3M%7qlvw;TXHyg+^D&n|KO zBuK}sRnKe)(M<4nmu;*}i_RZ0X*N}RxbSUV(K%7six`^VZ0AR+n67nm%NYHUC{zNY z;LD_dUoNt`u=Xju{M5ov@+oiq#gIX% z@xthUruWJ5u=&yMBG&l{aTWXKt0dM~Wd_eYE{)m3c<#fNUDombJuE)hcfDDcsd(16 zzH<~_7@_2ZxPcGf%!(W1*>syIh(4J$ydC0HVAyBI6B(4KoVjvL1q;X*S}1f-Ii9rK zHxdYYJiKJhOkSAUom%yThd*3jx=MdVA{ju8uI|~ZVd*msGwigF?^J!w`l`~{b$c+& zqn53WZYeBZ<6dD6(L6b6ROkJp5J<&q)a!R|vvkf}h|~JS<(ehd1l47c(?vY>G85zF zw#^%WE}Bz-*M?9fV0pjBbWvocyGhERterKs@&Q3@@MDTM6l?$&Agzg#Os2~_YU9mF z8T!_V@X@~SRDO$j4Vy|ihU=XSb^|^hXG`QM>)S$VA*6T0=V_9^wKuM?+##<7tM;rB zCMnNct!bbGn3;BIOfx%3rA6g%4>bQ;YG@_Kk#Lz%em-#$3)|q>Don%V`?W1;-93wV zyLr$@9R5)`QeA0{(xc@BsU+9%nf)fq#~p9xjM#mrqLBi{h#d2pfVVkp5=& ztBx6wNh#1ZSiQbIHD{8=Y23FT+lZ&q8l$0&o7bOW58A3XY1rl%U2vH^46mG0PV2=q zNd+fc6a#9>i!&$dMOZR0qX|G4OK_pa9WITBC-U_+s$qNW=tC7{aU@?oIc-ZQ!J4#K zsMT1I#uZrAUOZ*p>4)U)q;HiAIo%bJqU)lziqFkDf>}&RxMET3PvuIg8>@&dBr;H0 zgHH@QOqm;YQ>~)V=gU9Nbi3VG5Z<}Iz!Z+}gGq$gAhvSzvMU~Y0lLdx*-EEjPAqJ` zo(=b}RoGY=6NTdPenleZ96cgs-LL-w&z}*!___P_ee1z&@mO189^G_+;T5rY@0Smn zjFpN)$&EHo?@Bv{kq$h$$u|4UKh5g#-DYQcAs?Nq-m(wr8vP`K$UK^gSht(kn>!cM z(qD9KMk^Qf$$4!0Xc|q5wKeaKoA8TST_v6(t&+3h$+XlSP2hL-y49EM@1e**I`~+j zEUd_2PmAIvS^^X4)R6)difg>QXUsZ9MqXBaz9u?&-k$t5x;XfKou>f_{1##zj-$ImWJI5fJ{kmRfj)*f~2_+pVm}6Y$p}xs4 z;M%Ty{ysZ6wGt&mWh2yj$4l29A3R^|lI? zMtJw+aljb8d?W`~bW(r1$&Gxydsu@=t6yR2pBu_&%P-K3&!nmycr$%wB+jmWsFOMO z-0y~>v*VjI*=x5Ks%$zc%$)qjmWTUlS-!T}vYx-)t(cMIj^u3s3`abOKV_nZ-tScb zS;yb+Z_S~09r`(eb13RLVb$qAgkBZB9@|Ae?gjOWTr}R&>sgBrvCHBZ28hrEd*&ib zV~2fN;F_fBbweG=6n(t;ayf0W#tLO!?yJc)rr&C)mKgosCO z3pssV(&9wzev-Rq1BZ`ofVj-cj35o@dVVSAjhv}dlT*OyLiMK9s^j}8_x5_Qz3?1uFz!);(SUxF!nA$& z8Dp69RHw6LWvaQJVQ7D7(8;uFMBFg=N!4_5$;^YE`9wTli^17(nRTmmXFUTzzo*YA4g%z0VUWLX|&u`6h+G`bBcC(+^w#Ger&QNjFsUYvM>Cbo5V@-6 zvY&QN0ndk4*P7+CSUE+gXrx|>1G3AO9RR98z>pO~0~!M_prcFc4sj0uQPPVSFsWl? z5?NkpFY|oA4YhlsR4&r%x)sE)RWh}Br2Khc8X|G(DWkAHSPsof=3|?X8XT>Dm&xaN z3fu4J7kW(bOf9`lJR+^tI{FFr^>%#@gTdP@_~asE?K%|d1;Y2&ov}3Y2Qi3@yYvpD zAIit!`^qwt6I)Gfi+d?5?#TKZT=N|r92|z|O$W%s#aQ>Ey=t!#>y^xxovkRpd9i=f zC$~=Kgqd-2uj65_PuTcD6FTMyKX-!`-|?0NRbdN@i)Z**JbQk9`w-$Iz}{-vaLkSx zjy~nPHKyd*ea~S|9+ccjLNgU|%%Vb=%jtC+XKLabrJke;H!a1kB?#-*9#e(if{TFaTgHYq7|TdM!uAmZt; zW_KpHn4X_+ePWu)B#lS#1+B%GSR6w9q{d;pF6QB?^u;vryr4Rxb6&~`;4i=WCB@2m znuc6yjE6jD#Ez>*M;1@gS~FJ`a&$#1P?MZI7iD{YRPU9Kjr~SYA5L#aoShNYEx7j*q?p$*)uq%(dkZLsG@uV&U}Y$a zekn!0czZ!k8X5_aO@CCG_%i4Up)kd`pTYurV@&Q>@;SFsUI#|#w$IvLlw~&sx&jl_ zgdfd|y2csYVr;g3Wp#8$_v{+&8mBB1l%hOYe+$Q8w|W5+)S3WG;NCpuaW1 zGDoOJ^QW<$z~R%)lwqkm82R-N`vtys#cb<085I+@avuc6^ivdF_A8L-UiC#WNgeGb zqlh3Tbet^GMt0Bbr>s{Ugg-jRhZjC&5NLCe_K6I}DN*YrTM!^*bJDkppR$RL$%x>b zo~D_!Ui7wDIxr%;9WH!FT8(Iz=Sph^I$Elr%Cf|q#(cM*+B$k`Rl$!fnzp0JBOuci1&rm|4gdx0b#JorgnC~FzQ|7pemZrD-DrRHI<-G?`>V!~DKDyPVHi>=qkIZJ})J{<*p{T`RFLOuR z&T`toz6K_WiWuMbi92Dscv|?Ec=f>Ar4wa~^p(cQ3KyH(j9h8)yKYx)b2prx0-~*~ zvN-rGAT5>Tb246y)_d^1iSN4$)@PH1g(-z^J3&$#jT4VCeVQF + + + + + + API Reference + + + + + + + + + + + + + + + + + NAV + -image + + +
+ + +
+ + php + + python + + bash + + javascript + +
+ +
+ +
+
    + +
      +
    + + + + + +
    +
    +
    +
    +

    Introduction

    +

    Welcome to the Kittn API! You can use our API to can get information on various cats, kittens, and breeds in our database.

    +

    As you scroll, you'll see code examples for working with the API in Bash, PHP, Python, and JavaScript in the dark area to the right (or as part of the content on mobile), and you can switch the programming language of the examples with the tabs in the top right (or from the nav menu at the top left on mobile).

    +

    This example API documentation page was borrowed from Slate and generated with Pastel. Feel free to edit it and use it as a base for your own API's documentation.

    +

    Authentication

    +
    +

    To authorize, use this code:

    +
    +
    # With PHP, you can pass in the correct header with each request
+$client = new \GuzzleHttp\Client();
+$response = $client->get(
+    "api_endpoint_here",
+    [
+        'headers' => [
+            'Authorization' => 'meowmeowmeow',
+        ],
+    ]
+);
+$body = $response->getBody();
+print_r(json_decode((string) $body));
+
    +
    import kittn
+
+api = kittn.authorize('meowmeowmeow')
+
    +
    # With Bash, you pass in the correct header with each request
+curl "api_endpoint_here"
+  -H "Authorization: meowmeowmeow"
+
    +
    const kittn = require('kittn');
+
+let api = kittn.authorize('meowmeowmeow');
+
    +
    +

    Make sure to replace meowmeowmeow with your API key.

    +
    +

    Kittn uses API keys to allow access to the API. You can register a new Kittn API key at our developer portal.

    +

    Kittn expects for the API key to be included in all API requests to the server in a header that looks like the following:

    +

    Authorization: meowmeowmeow

    + +

    Kittens

    +

    Get All Kittens

    +
    $client = new \GuzzleHttp\Client();
+$response = $client->get("http://example.com/kittens/");
+$body = $response->getBody();
+print_r(json_decode((string) $body));
+
    +
    import kittn
+
+api = kittn.authorize('meowmeowmeow')
+api.kittens.get()
+
    +
    curl "http://example.com/api/kittens"
+  -H "Authorization: meowmeowmeow"
+
    +
    const kittn = require('kittn');
+
+let api = kittn.authorize('meowmeowmeow');
+let kittens = api.kittens.get();
+
    +
    +

    The above command returns JSON structured like this:

    +
    +
    [
+  {
+    "id": 1,
+    "name": "Fluffums",
+    "breed": "calico",
+    "fluffiness": 6,
+    "cuteness": 7
+  },
+  {
+    "id": 2,
+    "name": "Max",
+    "breed": "unknown",
+    "fluffiness": 5,
+    "cuteness": 10
+  }
+]
+
    +

    This endpoint retrieves all kittens.

    +

    HTTP Request

    +

    GET http://example.com/api/kittens

    +

    Query Parameters

    +

    + include_cats  Default: false +
    + If set to true, the result will also include cats. +

    +

    + available  Default: true +
    + If set to false, the result will include kittens that have already been adopted. +

    + +

    Get a Specific Kitten

    +
    $client = new \GuzzleHttp\Client();
+$response = $client->get('http://example.com/kittens/2');
+$body = $response->getBody();
+print_r(json_decode((string) $body));
+
    +
    import kittn
+
+api = kittn.authorize('meowmeowmeow')
+api.kittens.get(2)
+
    +
    curl "http://example.com/api/kittens/2"
+  -H "Authorization: meowmeowmeow"
+
    +
    const kittn = require('kittn');
+
+let api = kittn.authorize('meowmeowmeow');
+let max = api.kittens.get(2);
+
    +
    +

    The above command returns JSON structured like this:

    +
    +
    {
+  "id": 2,
+  "name": "Max",
+  "breed": "unknown",
+  "fluffiness": 5,
+  "cuteness": 10
+}
+
    +

    This endpoint retrieves a specific kitten.

    + +

    HTTP Request

    +

    GET http://example.com/kittens/<ID>

    +

    URL Parameters

    +

    + ID +
    + The ID of the kitten to retrieve. +

    +

    Delete a Specific Kitten

    +
    $client = new \GuzzleHttp\Client();
+$response = $client->delete('http://example.com/kittens/2');
+$body = $response->getBody();
+print_r(json_decode((string) $body));
+
    +
    import kittn
+
+api = kittn.authorize('meowmeowmeow')
+api.kittens.delete(2)
+
    +
    curl "http://example.com/api/kittens/2"
+  -X DELETE
+  -H "Authorization: meowmeowmeow"
+
    +
    const kittn = require('kittn');
+
+let api = kittn.authorize('meowmeowmeow');
+let max = api.kittens.delete(2);
+
    +
    +

    The above command returns JSON structured like this:

    +
    +
    {
+  "id": 2,
+  "deleted" : ":("
+}
+
    +

    This endpoint deletes a specific kitten.

    +

    HTTP Request

    +

    DELETE http://example.com/kittens/<ID>

    +

    URL Parameters

    +

    + ID +
    + The ID of the kitten to delete. +

    Errors

    + +

    The Kittn API uses the following error codes:

    +

    Error Code | Meaning +---------- | ------- +400 | Bad Request -- Your request is invalid. +401 | Unauthorized -- Your API key is wrong. +403 | Forbidden -- The kitten requested is hidden for administrators only. +404 | Not Found -- The specified kitten could not be found. +405 | Method Not Allowed -- You tried to access a kitten with an invalid method. +406 | Not Acceptable -- You requested a format that isn't json. +410 | Gone -- The kitten requested has been removed from our servers. +418 | I'm a teapot. +429 | Too Many Requests -- You're requesting too many kittens! Slow down! +500 | Internal Server Error -- We had a problem with our server. Try again later. +503 | Service Unavailable -- We're temporarily offline for maintenance. Please try again later.

    +
    +
    + +
    + + php + + python + + bash + + javascript + +
    + +
    +
    + + + + + \ No newline at end of file diff --git a/docs/js/all.js b/docs/js/all.js new file mode 100644 index 0000000..1804686 --- /dev/null +++ b/docs/js/all.js @@ -0,0 +1,6 @@ +!function(){if("ontouchstart"in window){var e,t,n,r,i,o,s={};e=function(e,t){return Math.abs(e[0]-t[0])>5||Math.abs(e[1]-t[1])>5},t=function(e){this.startXY=[e.touches[0].clientX,e.touches[0].clientY],this.threshold=!1},n=function(t){return this.threshold?!1:void(this.threshold=e(this.startXY,[t.touches[0].clientX,t.touches[0].clientY]))},r=function(t){if(!this.threshold&&!e(this.startXY,[t.changedTouches[0].clientX,t.changedTouches[0].clientY])){var n=t.changedTouches[0],r=document.createEvent("MouseEvents");r.initMouseEvent("click",!0,!0,window,0,n.screenX,n.screenY,n.clientX,n.clientY,!1,!1,!1,!1,0,null),r.simulated=!0,t.target.dispatchEvent(r)}},i=function(e){var t=Date.now(),n=t-s.time,r=e.clientX,i=e.clientY,a=[Math.abs(s.x-r),Math.abs(s.y-i)],c=o(e.target,"A")||e.target,l=c.nodeName,u="A"===l,d=window.navigator.standalone&&u&&e.target.getAttribute("href");return s.time=t,s.x=r,s.y=i,(!e.simulated&&(500>n||1500>n&&a[0]<50&&a[1]<50)||d)&&(e.preventDefault(),e.stopPropagation(),!d)?!1:(d&&(window.location=c.getAttribute("href")),void(c&&c.classList&&(c.classList.add("energize-focus"),window.setTimeout(function(){c.classList.remove("energize-focus")},150))))},o=function(e,t){for(var n=e;n!==document.body;){if(!n||n.nodeName===t)return n;n=n.parentNode}return null},document.addEventListener("touchstart",t,!1),document.addEventListener("touchmove",n,!1),document.addEventListener("touchend",r,!1),document.addEventListener("click",i,!0)}}(),!function(e,t){"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(e,t){function n(e){var t=e.length,n=G.type(e);return"function"===n||G.isWindow(e)?!1:1===e.nodeType&&t?!0:"array"===n||0===t||"number"==typeof t&&t>0&&t-1 in e}function r(e,t,n){if(G.isFunction(t))return G.grep(e,function(e,r){return!!t.call(e,r,e)!==n});if(t.nodeType)return G.grep(e,function(e){return e===t!==n});if("string"==typeof t){if(ae.test(t))return G.filter(t,e,n);t=G.filter(t,e)}return G.grep(e,function(e){return Q.call(t,e)>=0!==n})}function i(e,t){for(;(e=e[t])&&1!==e.nodeType;);return e}function o(e){var t=he[e]={};return G.each(e.match(pe)||[],function(e,n){t[n]=!0}),t}function s(){Y.removeEventListener("DOMContentLoaded",s,!1),e.removeEventListener("load",s,!1),G.ready()}function a(){Object.defineProperty(this.cache={},0,{get:function(){return{}}}),this.expando=G.expando+a.uid++}function c(e,t,n){var r;if(void 0===n&&1===e.nodeType)if(r="data-"+t.replace(we,"-$1").toLowerCase(),n=e.getAttribute(r),"string"==typeof n){try{n="true"===n?!0:"false"===n?!1:"null"===n?null:+n+""===n?+n:be.test(n)?G.parseJSON(n):n}catch(i){}ye.set(e,t,n)}else n=void 0;return n}function l(){return!0}function u(){return!1}function d(){try{return Y.activeElement}catch(e){}}function f(e,t){return G.nodeName(e,"table")&&G.nodeName(11!==t.nodeType?t:t.firstChild,"tr")?e.getElementsByTagName("tbody")[0]||e.appendChild(e.ownerDocument.createElement("tbody")):e}function p(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function h(e){var t=Re.exec(e.type);return t?e.type=t[1]:e.removeAttribute("type"),e}function g(e,t){for(var n=0,r=e.length;r>n;n++)ve.set(e[n],"globalEval",!t||ve.get(t[n],"globalEval"))}function m(e,t){var n,r,i,o,s,a,c,l;if(1===t.nodeType){if(ve.hasData(e)&&(o=ve.access(e),s=ve.set(t,o),l=o.events)){delete s.handle,s.events={};for(i in l)for(n=0,r=l[i].length;r>n;n++)G.event.add(t,i,l[i][n])}ye.hasData(e)&&(a=ye.access(e),c=G.extend({},a),ye.set(t,c))}}function v(e,t){var n=e.getElementsByTagName?e.getElementsByTagName(t||"*"):e.querySelectorAll?e.querySelectorAll(t||"*"):[];return void 0===t||t&&G.nodeName(e,t)?G.merge([e],n):n}function y(e,t){var n=t.nodeName.toLowerCase();"input"===n&&Ce.test(e.type)?t.checked=e.checked:("input"===n||"textarea"===n)&&(t.defaultValue=e.defaultValue)}function b(t,n){var r,i=G(n.createElement(t)).appendTo(n.body),o=e.getDefaultComputedStyle&&(r=e.getDefaultComputedStyle(i[0]))?r.display:G.css(i[0],"display");return i.detach(),o}function w(e){var t=Y,n=He[e];return n||(n=b(e,t),"none"!==n&&n||(Ie=(Ie||G("