Compare commits
No commits in common. 'master' and 'gh-pages' have entirely different histories.
61 changed files with 18572 additions and 5045 deletions
@ -1,3 +0,0 @@
@@ -1,3 +0,0 @@
|
||||
[submodule "mkdocs-material"] |
||||
path = mkdocs-material |
||||
url = https://git.charlesreid1.com/charlesreid1/mkdocs-material |
||||
@ -1,3 +0,0 @@
@@ -1,3 +0,0 @@
|
||||
node { |
||||
echo 'Hello from Pipeline' |
||||
} |
||||
@ -1,29 +0,0 @@
@@ -1,29 +0,0 @@
|
||||
BSD 3-Clause License |
||||
|
||||
Copyright (c) 2018, Charles Reid |
||||
All rights reserved. |
||||
|
||||
Redistribution and use in source and binary forms, with or without |
||||
modification, are permitted provided that the following conditions are met: |
||||
|
||||
* Redistributions of source code must retain the above copyright notice, this |
||||
list of conditions and the following disclaimer. |
||||
|
||||
* Redistributions in binary form must reproduce the above copyright notice, |
||||
this list of conditions and the following disclaimer in the documentation |
||||
and/or other materials provided with the distribution. |
||||
|
||||
* Neither the name of the copyright holder nor the names of its |
||||
contributors may be used to endorse or promote products derived from |
||||
this software without specific prior written permission. |
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
||||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
||||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
||||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE |
||||
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
||||
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR |
||||
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
||||
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
||||
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
||||
@ -1,6 +0,0 @@
@@ -1,6 +0,0 @@
|
||||
# search-demo-mkdocs-material |
||||
|
||||
Using mkdocs-material to make a pile of markdown documents containing links |
||||
to useful resources into a searchable, beautiful HTML page. |
||||
|
||||
See the demo in action here: [https://pages.charlesreid1.com/search-demo-mkdocs-material](https://pages.charlesreid1.com/search-demo-mkdocs-material) |
||||
File diff suppressed because one or more lines are too long
@ -0,0 +1,13 @@
@@ -0,0 +1,13 @@
|
||||
/*! |
||||
* Licensed under the Apache License, Version 2.0 (the "License"); you may not |
||||
* use this file except in compliance with the License. You may obtain a copy |
||||
* of the License at: |
||||
* |
||||
* http://www.apache.org/licenses/LICENSE-2.0 |
||||
* |
||||
* UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, SOFTWARE |
||||
* DISTRIBUTED UNDER THE LICENSE IS DISTRIBUTED ON AN "AS IS" BASIS, |
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. |
||||
* SEE THE LICENSE FOR THE SPECIFIC LANGUAGE GOVERNING PERMISSIONS AND |
||||
* LIMITATIONS UNDER THE LICENSE. |
||||
*/@font-face{font-family:"Material Icons";font-style:normal;font-weight:400;src:local("Material Icons"),local("MaterialIcons-Regular"),url("specimen/MaterialIcons-Regular.woff2") format("woff2"),url("specimen/MaterialIcons-Regular.woff") format("woff"),url("specimen/MaterialIcons-Regular.ttf") format("truetype")} |
||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
|
After Width: | Height: | Size: 521 B |
|
After Width: | Height: | Size: 1.4 KiB |
|
After Width: | Height: | Size: 1.2 KiB |
|
After Width: | Height: | Size: 1.6 KiB |
File diff suppressed because one or more lines are too long
@ -0,0 +1 @@
@@ -0,0 +1 @@
|
||||
!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");var r,i,n;e.da=function(){this.pipeline.reset(),this.pipeline.add(e.da.trimmer,e.da.stopWordFilter,e.da.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(e.da.stemmer))},e.da.wordCharacters="A-Za-zªºÀ-ÖØ-öø-ʸˠ-ˤᴀ-ᴥᴬ-ᵜᵢ-ᵥᵫ-ᵷᵹ-ᶾḀ-ỿⁱⁿₐ-ₜKÅℲⅎⅠ-ↈⱠ-ⱿꜢ-ꞇꞋ-ꞭꞰ-ꞷꟷ-ꟿꬰ-ꭚꭜ-ꭤff-stＡ-Ｚａ-ｚ",e.da.trimmer=e.trimmerSupport.generateTrimmer(e.da.wordCharacters),e.Pipeline.registerFunction(e.da.trimmer,"trimmer-da"),e.da.stemmer=(r=e.stemmerSupport.Among,i=e.stemmerSupport.SnowballProgram,n=new function(){var e,n,t,s=[new r("hed",-1,1),new r("ethed",0,1),new r("ered",-1,1),new r("e",-1,1),new r("erede",3,1),new r("ende",3,1),new r("erende",5,1),new r("ene",3,1),new r("erne",3,1),new r("ere",3,1),new r("en",-1,1),new r("heden",10,1),new r("eren",10,1),new r("er",-1,1),new r("heder",13,1),new r("erer",13,1),new r("s",-1,2),new r("heds",16,1),new r("es",16,1),new r("endes",18,1),new r("erendes",19,1),new r("enes",18,1),new r("ernes",18,1),new r("eres",18,1),new r("ens",16,1),new r("hedens",24,1),new r("erens",24,1),new r("ers",16,1),new r("ets",16,1),new r("erets",28,1),new r("et",-1,1),new r("eret",30,1)],o=[new r("gd",-1,-1),new r("dt",-1,-1),new r("gt",-1,-1),new r("kt",-1,-1)],a=[new r("ig",-1,1),new r("lig",0,1),new r("elig",1,1),new r("els",-1,1),new r("løst",-1,2)],d=[17,65,16,1,0,0,0,0,0,0,0,0,0,0,0,0,48,0,128],u=[239,254,42,3,0,0,0,0,0,0,0,0,0,0,0,0,16],c=new i;function l(){var e,r=c.limit-c.cursor;c.cursor>=n&&(e=c.limit_backward,c.limit_backward=n,c.ket=c.cursor,c.find_among_b(o,4)?(c.bra=c.cursor,c.limit_backward=e,c.cursor=c.limit-r,c.cursor>c.limit_backward&&(c.cursor--,c.bra=c.cursor,c.slice_del())):c.limit_backward=e)}this.setCurrent=function(e){c.setCurrent(e)},this.getCurrent=function(){return c.getCurrent()},this.stem=function(){var r,i=c.cursor;return function(){var r,i=c.cursor+3;if(n=c.limit,0<=i&&i<=c.limit){for(e=i;;){if(r=c.cursor,c.in_grouping(d,97,248)){c.cursor=r;break}if(c.cursor=r,r>=c.limit)return;c.cursor++}for(;!c.out_grouping(d,97,248);){if(c.cursor>=c.limit)return;c.cursor++}(n=c.cursor)<e&&(n=e)}}(),c.limit_backward=i,c.cursor=c.limit,function(){var e,r;if(c.cursor>=n&&(r=c.limit_backward,c.limit_backward=n,c.ket=c.cursor,e=c.find_among_b(s,32),c.limit_backward=r,e))switch(c.bra=c.cursor,e){case 1:c.slice_del();break;case 2:c.in_grouping_b(u,97,229)&&c.slice_del()}}(),c.cursor=c.limit,l(),c.cursor=c.limit,function(){var e,r,i,t=c.limit-c.cursor;if(c.ket=c.cursor,c.eq_s_b(2,"st")&&(c.bra=c.cursor,c.eq_s_b(2,"ig")&&c.slice_del()),c.cursor=c.limit-t,c.cursor>=n&&(r=c.limit_backward,c.limit_backward=n,c.ket=c.cursor,e=c.find_among_b(a,5),c.limit_backward=r,e))switch(c.bra=c.cursor,e){case 1:c.slice_del(),i=c.limit-c.cursor,l(),c.cursor=c.limit-i;break;case 2:c.slice_from("løs")}}(),c.cursor=c.limit,c.cursor>=n&&(r=c.limit_backward,c.limit_backward=n,c.ket=c.cursor,c.out_grouping_b(d,97,248)?(c.bra=c.cursor,t=c.slice_to(t),c.limit_backward=r,c.eq_v_b(t)&&c.slice_del()):c.limit_backward=r),!0}},function(e){return"function"==typeof e.update?e.update(function(e){return n.setCurrent(e),n.stem(),n.getCurrent()}):(n.setCurrent(e),n.stem(),n.getCurrent())}),e.Pipeline.registerFunction(e.da.stemmer,"stemmer-da"),e.da.stopWordFilter=e.generateStopWordFilter("ad af alle alt anden at blev blive bliver da de dem den denne der deres det dette dig din disse dog du efter eller en end er et for fra ham han hans har havde have hende hendes her hos hun hvad hvis hvor i ikke ind jeg jer jo kunne man mange med meget men mig min mine mit mod ned noget nogle nu når og også om op os over på selv sig sin sine sit skal skulle som sådan thi til ud under var vi vil ville vor være været".split(" ")),e.Pipeline.registerFunction(e.da.stopWordFilter,"stopWordFilter-da")}}); |
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@ -0,0 +1 @@
@@ -0,0 +1 @@
|
||||
!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");var r="2"==e.version[0];e.jp=function(){this.pipeline.reset(),this.pipeline.add(e.jp.stopWordFilter,e.jp.stemmer),r?this.tokenizer=e.jp.tokenizer:(e.tokenizer&&(e.tokenizer=e.jp.tokenizer),this.tokenizerFn&&(this.tokenizerFn=e.jp.tokenizer))};var t=new e.TinySegmenter;e.jp.tokenizer=function(n){if(!arguments.length||null==n||null==n)return[];if(Array.isArray(n))return n.map(function(t){return r?new e.Token(t.toLowerCase()):t.toLowerCase()});for(var i=n.toString().toLowerCase().replace(/^\s+/,""),o=i.length-1;o>=0;o--)if(/\S/.test(i.charAt(o))){i=i.substring(0,o+1);break}return t.segment(i).filter(function(e){return!!e}).map(function(t){return r?new e.Token(t):t})},e.jp.stemmer=function(e){return e},e.Pipeline.registerFunction(e.jp.stemmer,"stemmer-jp"),e.jp.wordCharacters="一二三四五六七八九十百千万億兆一-龠々〆ヵヶぁ-んァ-ヴーｱ-ﾝﾞa-zA-Zａ-ｚＡ-Ｚ0-9０-９",e.jp.stopWordFilter=function(t){if(-1===e.jp.stopWordFilter.stopWords.indexOf(r?t.toString():t))return t},e.jp.stopWordFilter=e.generateStopWordFilter("これ それ あれ この その あの ここ そこ あそこ こちら どこ だれ なに なん 何 私 貴方 貴方方 我々 私達 あの人 あのかた 彼女 彼 です あります おります います は が の に を で え から まで より も どの と し それで しかし".split(" ")),e.Pipeline.registerFunction(e.jp.stopWordFilter,"stopWordFilter-jp")}}); |
||||
@ -0,0 +1 @@
@@ -0,0 +1 @@
|
||||
!function(e,i){"function"==typeof define&&define.amd?define(i):"object"==typeof exports?module.exports=i():i()(e.lunr)}(this,function(){return function(e){e.multiLanguage=function(){for(var i=Array.prototype.slice.call(arguments),t=i.join("-"),r="",n=[],s=[],p=0;p<i.length;++p)"en"==i[p]?(r+="\\w",n.unshift(e.stopWordFilter),n.push(e.stemmer),s.push(e.stemmer)):(r+=e[i[p]].wordCharacters,n.unshift(e[i[p]].stopWordFilter),n.push(e[i[p]].stemmer),s.push(e[i[p]].stemmer));var o=e.trimmerSupport.generateTrimmer(r);return e.Pipeline.registerFunction(o,"lunr-multi-trimmer-"+t),n.unshift(o),function(){this.pipeline.reset(),this.pipeline.add.apply(this.pipeline,n),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add.apply(this.searchPipeline,s))}}}}); |
||||
@ -0,0 +1 @@
@@ -0,0 +1 @@
|
||||
!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");var r,n,i;e.no=function(){this.pipeline.reset(),this.pipeline.add(e.no.trimmer,e.no.stopWordFilter,e.no.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(e.no.stemmer))},e.no.wordCharacters="A-Za-zªºÀ-ÖØ-öø-ʸˠ-ˤᴀ-ᴥᴬ-ᵜᵢ-ᵥᵫ-ᵷᵹ-ᶾḀ-ỿⁱⁿₐ-ₜKÅℲⅎⅠ-ↈⱠ-ⱿꜢ-ꞇꞋ-ꞭꞰ-ꞷꟷ-ꟿꬰ-ꭚꭜ-ꭤff-stＡ-Ｚａ-ｚ",e.no.trimmer=e.trimmerSupport.generateTrimmer(e.no.wordCharacters),e.Pipeline.registerFunction(e.no.trimmer,"trimmer-no"),e.no.stemmer=(r=e.stemmerSupport.Among,n=e.stemmerSupport.SnowballProgram,i=new function(){var e,i,t=[new r("a",-1,1),new r("e",-1,1),new r("ede",1,1),new r("ande",1,1),new r("ende",1,1),new r("ane",1,1),new r("ene",1,1),new r("hetene",6,1),new r("erte",1,3),new r("en",-1,1),new r("heten",9,1),new r("ar",-1,1),new r("er",-1,1),new r("heter",12,1),new r("s",-1,2),new r("as",14,1),new r("es",14,1),new r("edes",16,1),new r("endes",16,1),new r("enes",16,1),new r("hetenes",19,1),new r("ens",14,1),new r("hetens",21,1),new r("ers",14,1),new r("ets",14,1),new r("et",-1,1),new r("het",25,1),new r("ert",-1,3),new r("ast",-1,1)],o=[new r("dt",-1,-1),new r("vt",-1,-1)],s=[new r("leg",-1,1),new r("eleg",0,1),new r("ig",-1,1),new r("eig",2,1),new r("lig",2,1),new r("elig",4,1),new r("els",-1,1),new r("lov",-1,1),new r("elov",7,1),new r("slov",7,1),new r("hetslov",9,1)],a=[17,65,16,1,0,0,0,0,0,0,0,0,0,0,0,0,48,0,128],m=[119,125,149,1],l=new n;this.setCurrent=function(e){l.setCurrent(e)},this.getCurrent=function(){return l.getCurrent()},this.stem=function(){var r,n,u,d,c=l.cursor;return function(){var r,n=l.cursor+3;if(i=l.limit,0<=n||n<=l.limit){for(e=n;;){if(r=l.cursor,l.in_grouping(a,97,248)){l.cursor=r;break}if(r>=l.limit)return;l.cursor=r+1}for(;!l.out_grouping(a,97,248);){if(l.cursor>=l.limit)return;l.cursor++}(i=l.cursor)<e&&(i=e)}}(),l.limit_backward=c,l.cursor=l.limit,function(){var e,r,n;if(l.cursor>=i&&(r=l.limit_backward,l.limit_backward=i,l.ket=l.cursor,e=l.find_among_b(t,29),l.limit_backward=r,e))switch(l.bra=l.cursor,e){case 1:l.slice_del();break;case 2:n=l.limit-l.cursor,l.in_grouping_b(m,98,122)?l.slice_del():(l.cursor=l.limit-n,l.eq_s_b(1,"k")&&l.out_grouping_b(a,97,248)&&l.slice_del());break;case 3:l.slice_from("er")}}(),l.cursor=l.limit,n=l.limit-l.cursor,l.cursor>=i&&(r=l.limit_backward,l.limit_backward=i,l.ket=l.cursor,l.find_among_b(o,2)?(l.bra=l.cursor,l.limit_backward=r,l.cursor=l.limit-n,l.cursor>l.limit_backward&&(l.cursor--,l.bra=l.cursor,l.slice_del())):l.limit_backward=r),l.cursor=l.limit,l.cursor>=i&&(d=l.limit_backward,l.limit_backward=i,l.ket=l.cursor,(u=l.find_among_b(s,11))?(l.bra=l.cursor,l.limit_backward=d,1==u&&l.slice_del()):l.limit_backward=d),!0}},function(e){return"function"==typeof e.update?e.update(function(e){return i.setCurrent(e),i.stem(),i.getCurrent()}):(i.setCurrent(e),i.stem(),i.getCurrent())}),e.Pipeline.registerFunction(e.no.stemmer,"stemmer-no"),e.no.stopWordFilter=e.generateStopWordFilter("alle at av bare begge ble blei bli blir blitt både båe da de deg dei deim deira deires dem den denne der dere deres det dette di din disse ditt du dykk dykkar då eg ein eit eitt eller elles en enn er et ett etter for fordi fra før ha hadde han hans har hennar henne hennes her hjå ho hoe honom hoss hossen hun hva hvem hver hvilke hvilken hvis hvor hvordan hvorfor i ikke ikkje ikkje ingen ingi inkje inn inni ja jeg kan kom korleis korso kun kunne kva kvar kvarhelst kven kvi kvifor man mange me med medan meg meget mellom men mi min mine mitt mot mykje ned no noe noen noka noko nokon nokor nokre nå når og også om opp oss over på samme seg selv si si sia sidan siden sin sine sitt sjøl skal skulle slik so som som somme somt så sånn til um upp ut uten var vart varte ved vere verte vi vil ville vore vors vort vår være være vært å".split(" ")),e.Pipeline.registerFunction(e.no.stopWordFilter,"stopWordFilter-no")}}); |
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@ -0,0 +1 @@
@@ -0,0 +1 @@
|
||||
!function(r,t){"function"==typeof define&&define.amd?define(t):"object"==typeof exports?module.exports=t():t()(r.lunr)}(this,function(){return function(r){r.stemmerSupport={Among:function(r,t,i,s){if(this.toCharArray=function(r){for(var t=r.length,i=new Array(t),s=0;s<t;s++)i[s]=r.charCodeAt(s);return i},!r&&""!=r||!t&&0!=t||!i)throw"Bad Among initialisation: s:"+r+", substring_i: "+t+", result: "+i;this.s_size=r.length,this.s=this.toCharArray(r),this.substring_i=t,this.result=i,this.method=s},SnowballProgram:function(){var r;return{bra:0,ket:0,limit:0,cursor:0,limit_backward:0,setCurrent:function(t){r=t,this.cursor=0,this.limit=t.length,this.limit_backward=0,this.bra=this.cursor,this.ket=this.limit},getCurrent:function(){var t=r;return r=null,t},in_grouping:function(t,i,s){if(this.cursor<this.limit){var e=r.charCodeAt(this.cursor);if(e<=s&&e>=i&&t[(e-=i)>>3]&1<<(7&e))return this.cursor++,!0}return!1},in_grouping_b:function(t,i,s){if(this.cursor>this.limit_backward){var e=r.charCodeAt(this.cursor-1);if(e<=s&&e>=i&&t[(e-=i)>>3]&1<<(7&e))return this.cursor--,!0}return!1},out_grouping:function(t,i,s){if(this.cursor<this.limit){var e=r.charCodeAt(this.cursor);if(e>s||e<i)return this.cursor++,!0;if(!(t[(e-=i)>>3]&1<<(7&e)))return this.cursor++,!0}return!1},out_grouping_b:function(t,i,s){if(this.cursor>this.limit_backward){var e=r.charCodeAt(this.cursor-1);if(e>s||e<i)return this.cursor--,!0;if(!(t[(e-=i)>>3]&1<<(7&e)))return this.cursor--,!0}return!1},eq_s:function(t,i){if(this.limit-this.cursor<t)return!1;for(var s=0;s<t;s++)if(r.charCodeAt(this.cursor+s)!=i.charCodeAt(s))return!1;return this.cursor+=t,!0},eq_s_b:function(t,i){if(this.cursor-this.limit_backward<t)return!1;for(var s=0;s<t;s++)if(r.charCodeAt(this.cursor-t+s)!=i.charCodeAt(s))return!1;return this.cursor-=t,!0},find_among:function(t,i){for(var s=0,e=i,n=this.cursor,u=this.limit,o=0,h=0,c=!1;;){for(var a=s+(e-s>>1),f=0,l=o<h?o:h,_=t[a],m=l;m<_.s_size;m++){if(n+l==u){f=-1;break}if(f=r.charCodeAt(n+l)-_.s[m])break;l++}if(f<0?(e=a,h=l):(s=a,o=l),e-s<=1){if(s>0||e==s||c)break;c=!0}}for(;;){if(o>=(_=t[s]).s_size){if(this.cursor=n+_.s_size,!_.method)return _.result;var b=_.method();if(this.cursor=n+_.s_size,b)return _.result}if((s=_.substring_i)<0)return 0}},find_among_b:function(t,i){for(var s=0,e=i,n=this.cursor,u=this.limit_backward,o=0,h=0,c=!1;;){for(var a=s+(e-s>>1),f=0,l=o<h?o:h,_=(m=t[a]).s_size-1-l;_>=0;_--){if(n-l==u){f=-1;break}if(f=r.charCodeAt(n-1-l)-m.s[_])break;l++}if(f<0?(e=a,h=l):(s=a,o=l),e-s<=1){if(s>0||e==s||c)break;c=!0}}for(;;){var m;if(o>=(m=t[s]).s_size){if(this.cursor=n-m.s_size,!m.method)return m.result;var b=m.method();if(this.cursor=n-m.s_size,b)return m.result}if((s=m.substring_i)<0)return 0}},replace_s:function(t,i,s){var e=s.length-(i-t),n=r.substring(0,t),u=r.substring(i);return r=n+s+u,this.limit+=e,this.cursor>=i?this.cursor+=e:this.cursor>t&&(this.cursor=t),e},slice_check:function(){if(this.bra<0||this.bra>this.ket||this.ket>this.limit||this.limit>r.length)throw"faulty slice operation"},slice_from:function(r){this.slice_check(),this.replace_s(this.bra,this.ket,r)},slice_del:function(){this.slice_from("")},insert:function(r,t,i){var s=this.replace_s(r,t,i);r<=this.bra&&(this.bra+=s),r<=this.ket&&(this.ket+=s)},slice_to:function(){return this.slice_check(),r.substring(this.bra,this.ket)},eq_v_b:function(r){return this.eq_s_b(r.length,r)}}}},r.trimmerSupport={generateTrimmer:function(r){var t=new RegExp("^[^"+r+"]+"),i=new RegExp("[^"+r+"]+$");return function(r){return"function"==typeof r.update?r.update(function(r){return r.replace(t,"").replace(i,"")}):r.replace(t,"").replace(i,"")}}}}}); |
||||
@ -0,0 +1 @@
@@ -0,0 +1 @@
|
||||
!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");var r,n,t;e.sv=function(){this.pipeline.reset(),this.pipeline.add(e.sv.trimmer,e.sv.stopWordFilter,e.sv.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(e.sv.stemmer))},e.sv.wordCharacters="A-Za-zªºÀ-ÖØ-öø-ʸˠ-ˤᴀ-ᴥᴬ-ᵜᵢ-ᵥᵫ-ᵷᵹ-ᶾḀ-ỿⁱⁿₐ-ₜKÅℲⅎⅠ-ↈⱠ-ⱿꜢ-ꞇꞋ-ꞭꞰ-ꞷꟷ-ꟿꬰ-ꭚꭜ-ꭤff-stＡ-Ｚａ-ｚ",e.sv.trimmer=e.trimmerSupport.generateTrimmer(e.sv.wordCharacters),e.Pipeline.registerFunction(e.sv.trimmer,"trimmer-sv"),e.sv.stemmer=(r=e.stemmerSupport.Among,n=e.stemmerSupport.SnowballProgram,t=new function(){var e,t,i=[new r("a",-1,1),new r("arna",0,1),new r("erna",0,1),new r("heterna",2,1),new r("orna",0,1),new r("ad",-1,1),new r("e",-1,1),new r("ade",6,1),new r("ande",6,1),new r("arne",6,1),new r("are",6,1),new r("aste",6,1),new r("en",-1,1),new r("anden",12,1),new r("aren",12,1),new r("heten",12,1),new r("ern",-1,1),new r("ar",-1,1),new r("er",-1,1),new r("heter",18,1),new r("or",-1,1),new r("s",-1,2),new r("as",21,1),new r("arnas",22,1),new r("ernas",22,1),new r("ornas",22,1),new r("es",21,1),new r("ades",26,1),new r("andes",26,1),new r("ens",21,1),new r("arens",29,1),new r("hetens",29,1),new r("erns",21,1),new r("at",-1,1),new r("andet",-1,1),new r("het",-1,1),new r("ast",-1,1)],s=[new r("dd",-1,-1),new r("gd",-1,-1),new r("nn",-1,-1),new r("dt",-1,-1),new r("gt",-1,-1),new r("kt",-1,-1),new r("tt",-1,-1)],a=[new r("ig",-1,1),new r("lig",0,1),new r("els",-1,1),new r("fullt",-1,3),new r("löst",-1,2)],o=[17,65,16,1,0,0,0,0,0,0,0,0,0,0,0,0,24,0,32],u=[119,127,149],m=new n;this.setCurrent=function(e){m.setCurrent(e)},this.getCurrent=function(){return m.getCurrent()},this.stem=function(){var r,n=m.cursor;return function(){var r,n=m.cursor+3;if(t=m.limit,0<=n||n<=m.limit){for(e=n;;){if(r=m.cursor,m.in_grouping(o,97,246)){m.cursor=r;break}if(m.cursor=r,m.cursor>=m.limit)return;m.cursor++}for(;!m.out_grouping(o,97,246);){if(m.cursor>=m.limit)return;m.cursor++}(t=m.cursor)<e&&(t=e)}}(),m.limit_backward=n,m.cursor=m.limit,function(){var e,r=m.limit_backward;if(m.cursor>=t&&(m.limit_backward=t,m.cursor=m.limit,m.ket=m.cursor,e=m.find_among_b(i,37),m.limit_backward=r,e))switch(m.bra=m.cursor,e){case 1:m.slice_del();break;case 2:m.in_grouping_b(u,98,121)&&m.slice_del()}}(),m.cursor=m.limit,r=m.limit_backward,m.cursor>=t&&(m.limit_backward=t,m.cursor=m.limit,m.find_among_b(s,7)&&(m.cursor=m.limit,m.ket=m.cursor,m.cursor>m.limit_backward&&(m.bra=--m.cursor,m.slice_del())),m.limit_backward=r),m.cursor=m.limit,function(){var e,r;if(m.cursor>=t){if(r=m.limit_backward,m.limit_backward=t,m.cursor=m.limit,m.ket=m.cursor,e=m.find_among_b(a,5))switch(m.bra=m.cursor,e){case 1:m.slice_del();break;case 2:m.slice_from("lös");break;case 3:m.slice_from("full")}m.limit_backward=r}}(),!0}},function(e){return"function"==typeof e.update?e.update(function(e){return t.setCurrent(e),t.stem(),t.getCurrent()}):(t.setCurrent(e),t.stem(),t.getCurrent())}),e.Pipeline.registerFunction(e.sv.stemmer,"stemmer-sv"),e.sv.stopWordFilter=e.generateStopWordFilter("alla allt att av blev bli blir blivit de dem den denna deras dess dessa det detta dig din dina ditt du där då efter ej eller en er era ert ett från för ha hade han hans har henne hennes hon honom hur här i icke ingen inom inte jag ju kan kunde man med mellan men mig min mina mitt mot mycket ni nu när någon något några och om oss på samma sedan sig sin sina sitta själv skulle som så sådan sådana sådant till under upp ut utan vad var vara varför varit varje vars vart vem vi vid vilka vilkas vilken vilket vår våra vårt än är åt över".split(" ")),e.Pipeline.registerFunction(e.sv.stopWordFilter,"stopWordFilter-sv")}}); |
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -1,252 +0,0 @@
@@ -1,252 +0,0 @@
|
||||
# Awesome REST [](https://github.com/sindresorhus/awesome) |
||||
|
||||
A collaborative list of great resources about RESTful API architecture, development, test, and performance. Feel free to contribute to this on-going list. |
||||
|
||||
* [Design](#design) |
||||
* [Standards](#standards) |
||||
* [Clients](#clients) |
||||
* [PHP](#php-clients) |
||||
* [Client-side JavaScript](#javascript-clients) |
||||
* [Node.js](#nodejs-clients) |
||||
* [Ruby](#ruby-clients) |
||||
* [Go](#go-clients) |
||||
* [Servers](#servers) |
||||
* [Directly On Top Of A RMDB](#directly-on-top-of-a-rmdb) |
||||
* [Node.js](#nodejs) |
||||
* [PHP](#php) |
||||
* [Symfony2](#symfony2) |
||||
* [Python](#python) |
||||
* [Ruby](#ruby) |
||||
* [Go](#go) |
||||
* [Java](#java) |
||||
* [Haskell](#haskell) |
||||
* [Testing](#testing) |
||||
* [Querying](#querying) |
||||
* [Mocking](#mocking) |
||||
* [Public REST APIs To Use In Tests](#public-rest-apis-to-use-in-tests) |
||||
* [Documentation](#documentation) |
||||
* [API Gateway](#api-gateway) |
||||
* [SaaS Tools](#saas-tools) |
||||
* [Miscellaneous](#miscellaneous) |
||||
|
||||
|
||||
|
||||
## Design |
||||
|
||||
* [Architectural Styles and |
||||
the Design of Network-based Software Architectures](https://www.ics.uci.edu/~fielding/pubs/dissertation/top.htm) - Roy Fielding's dissertation defining REST |
||||
* [HTTP API design guide extracted from work on the Heroku Platform API](https://github.com/interagent/http-api-design) |
||||
* [Best Practices for Designing a Pragmatic RESTful API](http://www.vinaysahni.com/best-practices-for-a-pragmatic-restful-api) |
||||
* [How to design a REST API?](http://blog.octo.com/en/design-a-rest-api/) - Full guide tackling security, pagination, filtering, versioning, partial answers, CORS, etc. |
||||
* [Richardson Maturity Model](http://martinfowler.com/articles/richardsonMaturityModel.html) - Explained by Martin Fowler, originally presented by Leonard Richardson at the [QCon 2008](https://www.crummy.com/writing/speaking/2008-QCon/act3.html). |
||||
* [Enterprise Integration Using REST](http://martinfowler.com/articles/enterpriseREST.html) - Discusses the constraints and flexibility that you have with nonpublic APIs, and lessons learned from doing large scale RESTful integration across multiple teams. |
||||
* [HATEOAS](http://timelessrepo.com/haters-gonna-hateoas) - Clear explanation on what HATEOAS is, and why you should use it. |
||||
* [How to GET a cup of coffee](http://www.infoq.com/articles/webber-rest-workflow/) |
||||
* [REST API Tutorial](http://www.restapitutorial.com/) - RestApiTutorial.com is dedicated to tracking REST API best practices and making resources available to enable quick reference and self education for the development crafts-person. |
||||
* [Microsoft REST API Guidelines](https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#readme) - The Microsoft REST API Guidelines, as a design principle, encourages application developers to have resources accessible to them via a RESTful HTTP interface. |
||||
* [API-Security-Checklist](https://github.com/shieldfy/API-Security-Checklist) - Best practices about REST API security |
||||
|
||||
## Standards |
||||
|
||||
* [JSON API](http://jsonapi.org/) - Standard for building APIs in JSON. |
||||
* [RAML](http://raml.org/) - Simple and succinct way to describe RESTful API. |
||||
* [JSend](http://labs.omniti.com/labs/jsend) - Simple specification that lays down some rules for how JSON responses from web servers should be formatted. |
||||
* [OData](http://www.odata.org/) - Open protocol to allow the creation and consumption of queryable and interoperable RESTful APIs. Quite complex. |
||||
* [HAL](http://stateless.co/hal_specification.html) - Simple format that gives a consistent and easy way to hyperlink between resources in your API (see: [HATEOAS](#hateoas)). |
||||
* [JSON-LD](http://json-ld.org/) - Standard for describing Linked Data and hypermedia relations in JSON (W3C). |
||||
* [Hydra](http://www.hydra-cg.com/) - Vocabulary for Hypermedia-Driven Web APIs (W3C). |
||||
* [Schema.org](http://schema.org) - Collection of schemas describing common data models. |
||||
* [OpenAPI](https://openapis.org/) - Formerly known as the Swagger Specification, OpenAPI specifcation is the world’s most popular description format for defining Restful APIs. |
||||
|
||||
## Clients |
||||
|
||||
### PHP Clients |
||||
|
||||
* [Guzzle](http://guzzle.readthedocs.org/en/latest/) - HTTP client and framework for consuming RESTful web services. |
||||
* [Buzz](https://github.com/kriswallsmith/buzz) - Another lightweight HTTP client. |
||||
* [unirest for PHP](https://github.com/Mashape/unirest-php) - Simplified, lightweight HTTP client library. |
||||
|
||||
### JavaScript Clients |
||||
|
||||
* [restangular](https://github.com/mgonto/restangular) - AngularJS service to handle REST API properly and easily. |
||||
* [restful.js](https://github.com/marmelab/restful.js) - JS client for interacting with server-side RESTful resources. |
||||
* [traverson](https://github.com/basti1302/traverson) - A Hypermedia API/HATEOAS Client for Node.js and the Browser |
||||
* [raml-client-generator](https://github.com/mulesoft/raml-client-generator) - Generates static client libs for js. |
||||
|
||||
### Node.js Clients |
||||
|
||||
* [restler](https://github.com/danwrong/restler) - REST client library for node.js. |
||||
* [unirest for Node.js](https://github.com/Mashape/unirest-nodejs) - Simplified, lightweight HTTP client library. |
||||
|
||||
### Ruby Clients |
||||
|
||||
* [RESTClient](https://github.com/rest-client/rest-client) - Simple HTTP and REST client for Ruby, inspired by microframework syntax for specifying actions. |
||||
* [Spyke](https://github.com/balvig/spyke) - Interact with REST services in an ActiveRecord-like manner. |
||||
* [excon](https://github.com/excon/excon) - Usable, fast, simple Ruby HTTP 1.1. It works great as a general HTTP(s) client and is particularly well suited to usage in API clients. |
||||
* [httparty](https://github.com/jnunemaker/httparty) - Makes HTTP fun again! |
||||
* [Net::HTTP](http://ruby-doc.org/stdlib/libdoc/net/http/rdoc/Net/HTTP.html) - Net::HTTP provides a rich library which can be used to build HTTP user-agents. |
||||
* [raml-ruby-client-generator](https://github.com/zlx/raml-ruby-client-generator) - Auto generate API client from a RAML file. |
||||
|
||||
### Go Clients |
||||
|
||||
* [gopencils](https://github.com/bndr/gopencils) - Small and simple package to easily consume REST APIs. |
||||
* [resty](https://github.com/go-resty/resty) - Simple HTTP and REST client for Go inspired by Ruby rest-client. |
||||
|
||||
## Servers |
||||
|
||||
### Directly On Top Of A RMDB |
||||
|
||||
* [postgrest](https://github.com/begriffs/postgrest) - Serve a fully RESTful API directly from an existing PostgreSQL database. |
||||
* [MySQL HTTP plugin](http://blog.ulf-wendel.de/2014/mysql-5-7-http-plugin-mysql/) - Simple REST-like / CRUD server for any MySQL database. |
||||
* [pREST](https://github.com/prest/prest) - A fully RESTful API from any existing PostgreSQL database written in Go. |
||||
|
||||
### Node.js |
||||
|
||||
* [node-restify](https://github.com/restify/node-restify) - Framework specifically meant for REST API. |
||||
* [Sails.js](http://sailsjs.org/) - Node.js Web framework embedding a command to generate automatically a REST API. |
||||
* [mers](https://github.com/jspears/mers) - Express service exposing Mongoose finders as RESTful API. |
||||
* [Baucis](https://github.com/wprl/baucis) - Build scalable REST API based on your Mongoose entities. |
||||
* [flatiron/resourceful](https://github.com/flatiron/resourceful) - Isomorphic Resource engine for JavaScript. |
||||
* [loopback](http://loopback.io/) - Powerful Node.js framework for creating APIs and easily connecting to backend data sources. |
||||
* [Feathers](http://feathersjs.com/) - is a real-time, micro-service web framework that gives you control over your data via RESTful resources, sockets and flexible plug-ins. |
||||
* [Expressa](https://github.com/thomas4019/expressa) - Express middleware for creating APIs from JSON schemas with a simple admin editor and permissions model. |
||||
|
||||
### PHP |
||||
|
||||
* [Microrest](https://github.com/marmelab/microrest.php) - Micro-web application providing a REST API on top of any relational database. |
||||
* [Negotiation](https://github.com/willdurand/Negotiation) - Content negotiation library. |
||||
* [Drest](https://github.com/leedavis81/drest) - Library for exposing Doctrine entities as REST resource endpoints. |
||||
* [Restler](https://github.com/Luracast/Restler) - Lightweight framework to expose PHP methods as RESTful web API. |
||||
* [HAL](https://github.com/blongden/hal) - Hypertext Application Language (HAL) builder library. |
||||
* [Apigility](https://github.com/zfcampus/zf-apigility-skeleton) - API builder built with Zend Framework 2. |
||||
* [phprest](https://github.com/phprest/phprest) - Specialized REST microframework for PHP. |
||||
* [Hateoas](https://github.com/willdurand/Hateoas) - PHP library to support implementing representations for HATEOAS REST web services. |
||||
* [Fusio](https://github.com/apioo/fusio) - Open source API management platform. |
||||
|
||||
#### Symfony2 |
||||
|
||||
* [REST APIs with Symfony2: the Right Way](http://williamdurand.fr/2012/08/02/rest-apis-with-symfony2-the-right-way/) - Complete guide to build a state-of-the-art REST API with Symfony2 framework. |
||||
* [FOSRestBundle](https://github.com/FriendsOfSymfony/FOSRestBundle) - Bundle handling view, routing, error handling, etc. for your REST API. |
||||
* [stanlemon/rest-bundle](https://github.com/stanlemon/rest-bundle) - Build a REST API based on Doctrine entities using conventions over configuration. |
||||
* [lakion/Lionframe](http://lakion.com/lionframe) - Glu between several community libraries to ease API development. |
||||
* [BazingaHateoasBundle](https://github.com/willdurand/BazingaHateoasBundle) - Integrate the [Hateoas](https://github.com/willdurand/Hateoas) library into a Symfony2 application. |
||||
* [Symfony REST Edition](https://github.com/gimler/symfony-rest-edition) - Start with a Symfony2 application with all REST-friendly bundles pre-configured. |
||||
* [NgAdminGeneratorBundle](https://github.com/marmelab/NgAdminGeneratorBundle) - Boostrap ng-admin configuration based on `stanlemon/rest-bundle`. |
||||
* [DunglasApiBundle](https://github.com/dunglas/DunglasApiBundle) - Build a REST API which follow Hydra/JSON-LD specification. |
||||
* [API Platform](https://github.com/api-platform/api-platform) - Specialize Symfony edition for the creation of hypermedia REST APIs. |
||||
* [NelmioApiDocBundle](https://github.com/nelmio/NelmioApiDocBundle) - Generate documentation for your REST API from annotations. |
||||
|
||||
### Python |
||||
|
||||
* [Django REST framework](http://www.django-rest-framework.org/) - Powerful and flexible toolkit that makes it easy to build Web APIs. |
||||
* [django-tastypie](http://tastypieapi.org/) - Creating delicious APIs for Django apps. |
||||
* [flask-restful](http://flask-restful.readthedocs.org/) - Extension for Flask that adds support for quickly building REST APIs. |
||||
* [flask-restless](https://flask-restless.readthedocs.org/en/latest/) - Flask extension for generating ReSTful APIs for database models defined with SQLAlchemy (or Flask-SQLAlchemy). |
||||
* [hug](http://www.hug.rest/) - Lightweight and fast API Framework. |
||||
* [sandman](https://github.com/jeffknupp/sandman) - Automated REST APIs for existing database-driven systems. |
||||
* [restless](http://restless.readthedocs.org/en/latest/) - Framework agnostic REST framework based on lessons learned from TastyPie. |
||||
* [savory-pie](https://github.com/RueLaLa/savory-pie/) - REST API building library (django, and others). |
||||
* [Python Eve](http://python-eve.org/) - Eve is an open source Python REST API framework designed for human beings. It allows to effortlessly build and deploy highly customizable, fully featured RESTful Web Services. |
||||
* [Ramses](https://ramses.readthedocs.org/en/stable/) - Makes RAML files executable by generating production-ready APIs from them at runtime. |
||||
* [Flask-Potion](https://github.com/biosustain/potion) - Flask-Potion is a powerful Flask extension for building RESTful JSON APIs. It also provides several Clients for easier access to the API. |
||||
* [apistar](https://github.com/encode/apistar) - A smart Web API framework, designed for Python 3. |
||||
|
||||
### Ruby |
||||
|
||||
* [Grape](http://www.ruby-grape.org) - Opinionated micro-framework for creating REST-like APIs in Ruby. |
||||
* [Rails](http://guides.rubyonrails.org/api_app.html) - RailsGuides: Using Rails for API-only applications. |
||||
|
||||
### Go |
||||
|
||||
* [gocrud](https://github.com/manishrjain/gocrud): Go library to simplify creating, updating and deleting arbitrary depth structured data — to make building REST services fast and easy. |
||||
* [go-json-rest](https://github.com/ant0ine/go-json-rest) - Thin layer on top of `net/http` that helps building RESTful APIs easily. |
||||
* [sleepy](https://github.com/dougblack/sleepy) - RESTful micro-framework written in Go. |
||||
* [restit](https://github.com/yookoala/restit) - Go micro framework to help writing RESTful API integration test. |
||||
* [go-relax](https://github.com/codehack/go-relax) - Framework of pluggable components to build RESTful API's. |
||||
* [go-rest](https://github.com/ungerik/go-rest) - Small and evil REST framework for Go. |
||||
* [go-restful](https://github.com/emicklei/go-restful) - A declarative highly readable framework for building restful API's. |
||||
* [Goat](https://github.com/bahlo/goat) - Minimalistic REST API server in Go. |
||||
* [Resoursea](https://github.com/resoursea/api) - REST framework for quickly writing resource based services. |
||||
* [Zerver](https://github.com/cosiner/zerver) - Zerver is a expressive, modular, feature completed RESTful framework. |
||||
|
||||
### Java |
||||
|
||||
* [RestExpress](https://github.com/RestExpress/RestExpress) - Netty-based, highly performant, lightweight, container-less, plugin-extensible, framework that is ideal for microservice architectures. |
||||
* [Vertx-Web](https://github.com/vert-x3/vertx-web) - Vert.x-Web is a set of building blocks for building web applications with Vert.x, a toolkit for building reactive applications on the JVM. |
||||
* [Dropwizard](https://github.com/dropwizard/dropwizard) - A framework for developing ops-friendly, high-performance, RESTful web services. |
||||
|
||||
### Haskell |
||||
* [Rest for Haskell](https://github.com/silkapp/rest) - This package allows you to create REST APIs in Haskell. These APIs can be run in different web frameworks. They can also be used to automatically generate documentation as well as client libraries. |
||||
|
||||
## Testing |
||||
|
||||
### Querying |
||||
|
||||
* [Hurl.it](https://www.hurl.it/) - Make HTTP requests with a simple web-based HTTP client -- like `curl` in the cloud. |
||||
* [httpie](https://github.com/jkbrzt/httpie) - Command line HTTP client, far more dev-friendly than `curl`. |
||||
* [Postman REST Client](https://chrome.google.com/webstore/detail/postman-rest-client/fdmmgilgnpjigdojojpjoooidkmcomcm) - Chrome extension essential to test manually REST API. |
||||
* [resty](https://github.com/micha/resty) - Little command line REST client that you can use in pipelines (bash or zsh). |
||||
* [jq](https://github.com/stedolan/jq) - Command line JSON processor, to use in combination with a command-line HTTP client like cURL. |
||||
* [HttpMaster](http://www.httpmaster.net) - GUI tool for testing REST APIs and services. Windows OS only. |
||||
* [Http-console](https://github.com/cloudhead/http-console) - Command line interface for HTTP that let you *speak HTTP like a local* |
||||
* [rest-assured](https://github.com/rest-assured/rest-assured) - Java DSL for easy testing of REST services. |
||||
|
||||
### Mocking |
||||
|
||||
* [RequestBin](http://requestb.in/) - Inspect and debug webhook requests sent by your clients or third-party APIs. |
||||
* [httpbin](http://httpbin.org) - HTTP request and response service - a/k/a Swiss Army Knife for HTTP. |
||||
* [FakeRest](https://github.com/marmelab/FakeRest) - Patch XMLHttpRequest to fake a REST API client-side. |
||||
* [json-server](https://github.com/typicode/json-server) - Serve a REST API from fixture files using quick prototyping. |
||||
* [Mocky.io](http://www.mocky.io/) - Free online service to create fake HTTP responses. |
||||
* [Swagger API Mock](https://github.com/bulkismaslom/swagger-api-mock) - Mock RESTful API based on swagger schema |
||||
* [Request Baskets](https://github.com/darklynx/request-baskets) - Service to collect HTTP requests and inspect them via RESTful API or web UI. |
||||
* [DuckRails](https://github.com/iridakos/duckrails) - Mock quickly & dynamically API endpoints. |
||||
|
||||
### Public REST APIs To Use In Tests |
||||
* [Deck of Cards API](http://deckofcardsapi.com) - Open API for simulating a deck of cards. |
||||
* [ProgrammableWeb](http://www.programmableweb.com/apis/directory) - The world's largest API repository. |
||||
* [Public APIS](https://www.publicapis.com/) - Explore The Largest API Directory In The Galaxy. |
||||
* [Marvel Comics API](http://developer.marvel.com/) - Query characters, stories, events about Marvel superheroes. |
||||
* [JSON Placeholder](http://jsonplaceholder.typicode.com/) - Free online REST service that you can use whenever you need some fake data. |
||||
* [APIs.guru](http://APIs.guru) - Wikipedia for Web APIs, each API has OpenAPI/Swagger description. |
||||
|
||||
## Documentation |
||||
|
||||
* [Swagger](http://swagger.io/) - Documentation/querying web interface for REST APIs. |
||||
* [API doc](http://apidocjs.com/) - Inline Documentation for RESTful web APIs. |
||||
* [raml2html](https://github.com/raml2html/raml2html) - Generates HTML documentation from a RAML file. |
||||
* [ReDoc](https://github.com/Rebilly/ReDoc/) - OpenAPI/Swagger-powered three-panel documentation. |
||||
* [Slate](https://github.com/lord/slate) - Beautiful and responsive three-panel API documentation using Middleman. |
||||
|
||||
## API Gateway |
||||
|
||||
* [Kong](https://github.com/Kong/kong) - Scalable, distributed, and plugin oriented API gateway backed by Nginx. |
||||
* [Tyk API Gateway](https://github.com/TykTechnologies/tyk) - Lightweight API gateway with analytics logging, written in Go. |
||||
* [API Umbrella](https://github.com/NREL/api-umbrella) - API management platform for exposing web services, with web interface and analytics, written in Lua. |
||||
* [WSO2 API Management](https://github.com/wso2/product-apim) - API management tool with lightweight gateway and API lifecycle manangement, written in Java. |
||||
|
||||
## SaaS Tools |
||||
|
||||
* [Runscope](https://www.runscope.com/) - Automated API Monitoring & Testing. |
||||
* [Ping-API](https://ping-api.com/) - Automated API Monitoring & Testing. |
||||
* [import.io Magic](https://magic.import.io/) - Create a REST API from any website in one click. |
||||
* [Apiary](https://apiary.io/) - Collaborative design, instant API mock, generated documentation, integrated code samples, debugging and automated testing. |
||||
* [Amazon API Gateway](https://aws.amazon.com/api-gateway/) - Amazon API Gateway is a fully managed service that makes it easy for developers to create, publish, maintain, monitor, and secure APIs at any scale. |
||||
* [Apigee](https://apigee.com) - Apigee is the leading provider of API technology and services for enterprises and developers. |
||||
* [3scale](https://www.3scale.net/) - Nginx based API gateway to integrate internal and external API services with 3scale's API Management Platform. |
||||
* [Assertible](https://assertible.com) - Continuously test and monitor your APIs after deployments and across environments. |
||||
* [Moesif](https://www.moesif.com) - API Analytics for Debugging, Monitoring, and Usage Tracking for RESTful and GraphQL. |
||||
|
||||
|
||||
## Miscellaneous |
||||
|
||||
* [ng-admin](https://github.com/marmelab/ng-admin) - Add an AngularJS admin GUI to any RESTful API. |
||||
* [admin-on-rest](https://github.com/marmelab/admin-on-rest) - Add a ReactJS admin GUI to any RESTful API. |
||||
* [swagger-codegen](https://github.com/swagger-api/swagger-codegen) - Auto generation of client libraries or server stubs given an OpenAPI specification (formerly known as the Swagger Specification). |
||||
* [Lumber](https://github.com/ForestAdmin/lumber) - Generate the admin interface of your application. |
||||
|
||||
## License |
||||
|
||||
[](http://creativecommons.org/licenses/by/4.0/) |
||||
|
||||
This work is licensed under a [Creative Commons Attribution 4.0 International License](http://creativecommons.org/licenses/by/4.0/). |
||||
@ -1,195 +0,0 @@
@@ -1,195 +0,0 @@
|
||||
# Awesome Vim |
||||
|
||||
Plugins are organized by section and ordered alphabetically. |
||||
|
||||
## Table of Contents |
||||
|
||||
1. [Learning Vim](#learning-vim) |
||||
2. [Plugin Management](#plugin-management) |
||||
3. [Colors](#colors) |
||||
4. [Tools](#tools) |
||||
5. [Language Specific](#language-specific) |
||||
6. [Framework Specific](#framework-specific) |
||||
7. [Distributions](#distributions) |
||||
8. [Websites](#websites) |
||||
9. [Contributing](#contributing) |
||||
10. [License](#license) |
||||
|
||||
|
||||
## Learning Vim |
||||
|
||||
* [Seven habits of effective text editing](http://www.moolenaar.net/habits.html) |
||||
* [The Way of the Vim Warrior](https://github.com/dahu/LearnVim) |
||||
* [Learn Vimscript the Hard Way](http://learnvimscriptthehardway.stevelosh.com/) |
||||
* [Vim Adventures](http://vim-adventures.com/) |
||||
* [Vim Genius](http://www.vimgenius.com/) |
||||
* [Vim Tips](http://zzapper.co.uk/vimtips.html) |
||||
* [Fortune vimtips](https://github.com/hobbestigrou/vimtips-fortune) |
||||
* [Vim Galore](https://github.com/mhinz/vim-galore) |
||||
|
||||
|
||||
## Plugin Management |
||||
|
||||
* [Neobundle](https://github.com/Shougo/neobundle.vim) |
||||
* [Pathogen](https://github.com/tpope/vim-pathogen) |
||||
* [VAM](https://github.com/MarcWeber/vim-addon-manager) |
||||
* [Vim-plug](https://github.com/junegunn/vim-plug) |
||||
* [Vundle](https://github.com/gmarik/Vundle.vim) |
||||
|
||||
|
||||
## Colors |
||||
|
||||
* [Apprentice](https://github.com/romainl/Apprentice) |
||||
* [Base16](https://github.com/chriskempson/base16-vim/) |
||||
* [Jellybeans](https://github.com/nanotech/jellybeans.vim) |
||||
* [Molokai](https://github.com/tomasr/molokai) |
||||
* [Solarized](https://github.com/altercation/vim-colors-solarized) |
||||
|
||||
|
||||
## Tools |
||||
|
||||
### Editing |
||||
|
||||
* [Abolish](https://github.com/tpope/vim-abolish) |
||||
* [Align](https://github.com/vim-scripts/Align) |
||||
* [DelimitMate](https://github.com/Raimondi/delimitMate) |
||||
* [EditorConfig](https://github.com/editorconfig/editorconfig-vim) |
||||
* [ExpandRegion](https://github.com/terryma/vim-expand-region) |
||||
* [Gundo](https://github.com/sjl/gundo.vim) |
||||
* [IndentGuides](https://github.com/nathanaelkane/vim-indent-guides) |
||||
* [NerdCommenter](https://github.com/scrooloose/nerdcommenter) |
||||
* [Repeat](https://github.com/tpope/vim-repeat) |
||||
* [Surround](https://github.com/tpope/vim-surround) |
||||
* [Tabular](https://github.com/godlygeek/tabular) |
||||
* [Targets](https://github.com/wellle/targets.vim) |
||||
* [TComment](https://github.com/tomtom/tcomment_vim) |
||||
* [TextobjIndent](https://github.com/kana/vim-textobj-indent) |
||||
* [TextobjUser](https://github.com/kana/vim-textobj-user) |
||||
* [TextobjWordColumn](https://github.com/coderifous/textobj-word-column.vim) |
||||
* [Unimpaired](https://github.com/tpope/vim-unimpaired) |
||||
* [VisualSplit](https://github.com/wellle/visual-split.vim) |
||||
* [YankStack](https://github.com/maxbrunsfeld/vim-yankstack) |
||||
|
||||
### File Management |
||||
|
||||
* [Dirvish](https://github.com/justinmk/vim-dirvish) |
||||
* [NERDTree](https://github.com/scrooloose/nerdtree) |
||||
* [Vinegar](https://github.com/tpope/vim-vinegar) |
||||
|
||||
### Git |
||||
|
||||
* [Fugitive](https://github.com/tpope/vim-fugitive) |
||||
* [vim-gitgutter](https://github.com/airblade/vim-gitgutter) |
||||
|
||||
### Interface |
||||
|
||||
* [Airline](https://github.com/bling/vim-airline) + [Airline Themes](https://github.com/vim-airline/vim-airline-themes) |
||||
* [vim-lastplace](https://github.com/farmergreg/vim-lastplace) |
||||
* [Signify](https://github.com/mhinz/vim-signify) |
||||
* [Startify](https://github.com/mhinz/vim-startify) |
||||
|
||||
### Searching |
||||
|
||||
* [Ack](https://github.com/mileszs/ack.vim) |
||||
* [CtrlP](https://github.com/ctrlpvim/ctrlp.vim) |
||||
* [vim-codequery](https://github.com/devjoe/vim-codequery) |
||||
|
||||
### Task Running |
||||
|
||||
* [Dispatch](https://github.com/tpope/vim-dispatch) |
||||
|
||||
### Text Navigation |
||||
|
||||
* [EasyMotion](https://github.com/easymotion/vim-easymotion) |
||||
* [Sneak](https://github.com/justinmk/vim-sneak) |
||||
|
||||
### Snippets |
||||
|
||||
* [Snippets](https://github.com/honza/vim-snippets) |
||||
* [UltiSnips](https://github.com/sirver/UltiSnips) |
||||
|
||||
### Syntax/Completion |
||||
|
||||
* [Asynchronous Lint Engine](https://github.com/w0rp/ale) |
||||
* [Neocomplete](https://github.com/Shougo/neocomplete.vim) |
||||
* [Syntastic](https://github.com/scrooloose/syntastic) |
||||
* [TmuxComplete](https://github.com/wellle/tmux-complete.vim) |
||||
* [YouCompleteMe](https://github.com/Valloric/YouCompleteMe) |
||||
|
||||
|
||||
## Language Specific |
||||
|
||||
* [Codi](https://github.com/metakirby5/codi.vim) |
||||
* [Polyglot](https://github.com/sheerun/vim-polyglot) |
||||
|
||||
### HTML |
||||
|
||||
* [MatchTagAlways](https://github.com/valloric/MatchTagAlways) |
||||
* [vim-ionic2](https://github.com/akz92/vim-ionic2) |
||||
|
||||
### Java |
||||
|
||||
* [Eclim](http://eclim.org/) |
||||
* [Ensime](http://ensime.org/editors/vim/) |
||||
|
||||
### Javascript |
||||
|
||||
* [JavascriptLibrariesSyntax](https://github.com/othree/javascript-libraries-syntax.vim) |
||||
* [TernForVim](https://github.com/marijnh/tern_for_vim) |
||||
|
||||
### Markdown |
||||
|
||||
* [vim-instant-markdown](https://github.com/suan/vim-instant-markdown) |
||||
* [vim-markdown-toc](https://github.com/mzlogin/vim-markdown-toc) |
||||
|
||||
### PHP |
||||
|
||||
* [PDV](https://github.com/tobyS/pdv) |
||||
|
||||
### Python |
||||
|
||||
* [PythonMode](https://github.com/klen/python-mode) |
||||
|
||||
### Ruby |
||||
|
||||
* [Endwise](https://github.com/tpope/vim-endwise) |
||||
|
||||
### XML |
||||
|
||||
* [xmledit](https://github.com/sukima/xmledit/) |
||||
|
||||
## Framework Specific |
||||
|
||||
### Django |
||||
|
||||
* [htmldjango autocomplete](https://github.com/mjbrownie/vim-htmldjango_omnicomplete) |
||||
* [Pony](https://github.com/jmcomets/vim-pony/) |
||||
|
||||
### Rails |
||||
|
||||
* [Rails](https://github.com/tpope/vim-rails) |
||||
|
||||
## Distributions |
||||
|
||||
* [Janus](https://github.com/carlhuda/janus) |
||||
* [spf13](https://github.com/spf13/spf13-vim) |
||||
|
||||
## Websites |
||||
|
||||
* [Vim Bootstrap](http://vim-bootstrap.com/) |
||||
* [usevim](http://usevim.com/) |
||||
* [Vim Awesome](http://vimawesome.com/) |
||||
* [Vivify](http://bytefluent.com/vivify/) |
||||
* [/r/vim](http://www.reddit.com/r/vim) |
||||
* [Vimcasts](http://vimcasts.org/) |
||||
|
||||
## Contributing |
||||
|
||||
* Please read the [contribution guidelines](https://github.com/akrawchyk/awesome-vim/blob/master/contributing.md) |
||||
|
||||
## License |
||||
|
||||
* [MIT License](https://github.com/akrawchyk/awesome-vim/blob/master/LICENSE) |
||||
|
||||
|
||||
Shameless plug for my vimrc [akrawchyk/dotfiles](https://github.com/akrawchyk/dotfiles/tree/master/vim). |
||||
@ -1,23 +0,0 @@
@@ -1,23 +0,0 @@
|
||||
# Searching with Mkdocs-Material |
||||
|
||||
This is a quick demonstration of how to index a large body of links |
||||
and make it searchable using the search functionality built into the |
||||
mkdocs-material theme for mkdocs. |
||||
|
||||
This is as simple as it gets: create a directory, put a pile of markdown |
||||
files into the directory, and run `mkdocs build` to create a site *and* |
||||
a search index. |
||||
|
||||
We document a couple of awesome lists, which are large curated lists of links: |
||||
|
||||
* [awesome-public-datasets](https://github.com/awesomedata/awesome-public-datasets/blob/master/README.rst) |
||||
* [awesome-big-data](https://github.com/onurakpolat/awesome-bigdata) |
||||
* [awesome-vim](https://github.com/akrawchyk/awesome-vim) |
||||
* [awesome-rest](https://github.com/marmelab/awesome-rest) |
||||
* [awesome-python](https://github.com/vinta/awesome-python) |
||||
* [awesome-r](https://github.com/qinwf/awesome-R) |
||||
|
||||
To take this thing for a test drive, just start typing into the search box |
||||
at the top of the page. |
||||
|
||||
Try searching for the term **healthcare**. |
||||
@ -0,0 +1,422 @@
@@ -0,0 +1,422 @@
|
||||
|
||||
|
||||
|
||||
|
||||
<!DOCTYPE html> |
||||
<html lang="en" class="no-js"> |
||||
<head> |
||||
|
||||
<meta charset="utf-8"> |
||||
<meta name="viewport" content="width=device-width,initial-scale=1"> |
||||
<meta http-equiv="x-ua-compatible" content="ie=edge"> |
||||
|
||||
|
||||
<link rel="canonical" href="https://pages.charlesreid1.com/search-demo-mkdocs-material/"> |
||||
|
||||
|
||||
|
||||
<meta name="lang:clipboard.copy" content="Copy to clipboard"> |
||||
|
||||
<meta name="lang:clipboard.copied" content="Copied to clipboard"> |
||||
|
||||
<meta name="lang:search.language" content="en"> |
||||
|
||||
<meta name="lang:search.pipeline.stopwords" content="True"> |
||||
|
||||
<meta name="lang:search.pipeline.trimmer" content="True"> |
||||
|
||||
<meta name="lang:search.result.none" content="No matching documents"> |
||||
|
||||
<meta name="lang:search.result.one" content="1 matching document"> |
||||
|
||||
<meta name="lang:search.result.other" content="# matching documents"> |
||||
|
||||
<meta name="lang:search.tokenizer" content="[\s\-]+"> |
||||
|
||||
<link rel="shortcut icon" href="."> |
||||
<meta name="generator" content="mkdocs-1.0, mkdocs-material-3.0.3"> |
||||
|
||||
|
||||
|
||||
<title>search-demo-mkdocs-material</title> |
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="assets/stylesheets/application.451f80e5.css"> |
||||
|
||||
<link rel="stylesheet" href="assets/stylesheets/application-palette.22915126.css"> |
||||
|
||||
|
||||
|
||||
|
||||
<meta name="theme-color" content=""> |
||||
|
||||
|
||||
|
||||
<script src="assets/javascripts/modernizr.1aa3b519.js"></script> |
||||
|
||||
|
||||
<link href="https://fonts.gstatic.com" rel="preconnect" crossorigin> |
||||
|
||||
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700|Roboto+Mono"> |
||||
<style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style> |
||||
|
||||
|
||||
<link rel="stylesheet" href="assets/fonts/material-icons.css"> |
||||
|
||||
<link rel="stylesheet" href="css/custom.css"> |
||||
|
||||
|
||||
</head> |
||||
|
||||
|
||||
|
||||
<body dir="ltr" data-md-color-primary="dark-blue" data-md-color-accent="dark-blue"> |
||||
|
||||
<svg class="md-svg"> |
||||
<defs> |
||||
|
||||
|
||||
</defs> |
||||
</svg> |
||||
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off"> |
||||
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off"> |
||||
<label class="md-overlay" data-md-component="overlay" for="__drawer"></label> |
||||
|
||||
<a href="#searching-with-mkdocs-material" tabindex="1" class="md-skip"> |
||||
Skip to content |
||||
</a> |
||||
|
||||
|
||||
<header class="md-header" data-md-component="header"> |
||||
<nav class="md-header-nav md-grid"> |
||||
<div class="md-flex"> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<a href="https://pages.charlesreid1.com/search-demo-mkdocs-material" title="search-demo-mkdocs-material" class="md-header-nav__button md-logo"> |
||||
|
||||
<i class="md-icon">search</i> |
||||
|
||||
</a> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--stretch"> |
||||
<div class="md-flex__ellipsis md-header-nav__title" data-md-component="title"> |
||||
|
||||
|
||||
<span class="md-header-nav__topic"> |
||||
search-demo-mkdocs-material |
||||
</span> |
||||
<span class="md-header-nav__topic"> |
||||
Searching with Mkdocs-Material |
||||
</span> |
||||
|
||||
|
||||
</div> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
|
||||
|
||||
<label class="md-icon md-icon--search md-header-nav__button" for="__search"></label> |
||||
|
||||
<div class="md-search" data-md-component="search" role="dialog"> |
||||
<label class="md-search__overlay" for="__search"></label> |
||||
<div class="md-search__inner" role="search"> |
||||
<form class="md-search__form" name="search"> |
||||
<input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active"> |
||||
<label class="md-icon md-search__icon" for="__search"></label> |
||||
<button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1"> |
||||
 |
||||
</button> |
||||
</form> |
||||
<div class="md-search__output"> |
||||
<div class="md-search__scrollwrap" data-md-scrollfix> |
||||
<div class="md-search-result" data-md-component="result"> |
||||
<div class="md-search-result__meta"> |
||||
Type to start searching |
||||
</div> |
||||
<ol class="md-search-result__list"></ol> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
|
||||
|
||||
</div> |
||||
|
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<div class="md-header-nav__source"> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a href="https://git.charlesreid1.com/charlesreid1/search-demo-mkdocs-material" title="Go to repository" class="md-source" data-md-source=""> |
||||
|
||||
<div class="md-source__repository"> |
||||
charlesreid1/search-demo-mkdocs-material |
||||
</div> |
||||
</a> |
||||
|
||||
</div> |
||||
</div> |
||||
|
||||
</div> |
||||
</nav> |
||||
</header> |
||||
|
||||
<div class="md-container"> |
||||
|
||||
|
||||
|
||||
<main class="md-main"> |
||||
<div class="md-main__inner md-grid" data-md-component="container"> |
||||
|
||||
|
||||
<div class="md-sidebar md-sidebar--primary" data-md-component="navigation"> |
||||
<div class="md-sidebar__scrollwrap"> |
||||
<div class="md-sidebar__inner"> |
||||
<nav class="md-nav md-nav--primary" data-md-level="0"> |
||||
<label class="md-nav__title md-nav__title--site" for="__drawer"> |
||||
<a href="https://pages.charlesreid1.com/search-demo-mkdocs-material" title="search-demo-mkdocs-material" class="md-nav__button md-logo"> |
||||
|
||||
<i class="md-icon">search</i> |
||||
|
||||
</a> |
||||
search-demo-mkdocs-material |
||||
</label> |
||||
|
||||
<div class="md-nav__source"> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a href="https://git.charlesreid1.com/charlesreid1/search-demo-mkdocs-material" title="Go to repository" class="md-source" data-md-source=""> |
||||
|
||||
<div class="md-source__repository"> |
||||
charlesreid1/search-demo-mkdocs-material |
||||
</div> |
||||
</a> |
||||
|
||||
</div> |
||||
|
||||
<ul class="md-nav__list" data-md-scrollfix> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item md-nav__item--active"> |
||||
|
||||
<input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc"> |
||||
|
||||
|
||||
|
||||
|
||||
<a href="." title="Searching with Mkdocs-Material" class="md-nav__link md-nav__link--active"> |
||||
Searching with Mkdocs-Material |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="awesome-big-data/" title="Awesome Big Data" class="md-nav__link"> |
||||
Awesome Big Data |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="awesome-public-datasets/" title="Awesome Public Datasets" class="md-nav__link"> |
||||
Awesome Public Datasets |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="awesome-python/" title="Awesome Python [](https://github.com/sindresorhus/awesome)" class="md-nav__link"> |
||||
Awesome Python [](https://github.com/sindresorhus/awesome) |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="awesome-r/" title="Awesome R" class="md-nav__link"> |
||||
Awesome R |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="awesome-rest/" title="Awesome REST [](https://github.com/sindresorhus/awesome)" class="md-nav__link"> |
||||
Awesome REST [](https://github.com/sindresorhus/awesome) |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="awesome-vim/" title="Awesome Vim" class="md-nav__link"> |
||||
Awesome Vim |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
</ul> |
||||
</nav> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
|
||||
|
||||
<div class="md-sidebar md-sidebar--secondary" data-md-component="toc"> |
||||
<div class="md-sidebar__scrollwrap"> |
||||
<div class="md-sidebar__inner"> |
||||
|
||||
<nav class="md-nav md-nav--secondary"> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</nav> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
|
||||
|
||||
<div class="md-content"> |
||||
<article class="md-content__inner md-typeset"> |
||||
|
||||
|
||||
|
||||
<h1 id="searching-with-mkdocs-material">Searching with Mkdocs-Material</h1> |
||||
<p>This is a quick demonstration of how to index a large body of links |
||||
and make it searchable using the search functionality built into the |
||||
mkdocs-material theme for mkdocs.</p> |
||||
<p>This is as simple as it gets: create a directory, put a pile of markdown |
||||
files into the directory, and run <code>mkdocs build</code> to create a site <em>and</em> |
||||
a search index.</p> |
||||
<p>We document a couple of awesome lists, which are large curated lists of links:</p> |
||||
<ul> |
||||
<li><a href="https://github.com/awesomedata/awesome-public-datasets/blob/master/README.rst">awesome-public-datasets</a></li> |
||||
<li><a href="https://github.com/onurakpolat/awesome-bigdata">awesome-big-data</a></li> |
||||
<li><a href="https://github.com/akrawchyk/awesome-vim">awesome-vim</a></li> |
||||
<li><a href="https://github.com/marmelab/awesome-rest">awesome-rest</a></li> |
||||
<li><a href="https://github.com/vinta/awesome-python">awesome-python</a></li> |
||||
<li><a href="https://github.com/qinwf/awesome-R">awesome-r</a></li> |
||||
</ul> |
||||
<p>To take this thing for a test drive, just start typing into the search box |
||||
at the top of the page.</p> |
||||
<p>Try searching for the term <strong>healthcare</strong>.</p> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article> |
||||
</div> |
||||
</div> |
||||
</main> |
||||
|
||||
|
||||
<footer class="md-footer"> |
||||
|
||||
<div class="md-footer-nav"> |
||||
<nav class="md-footer-nav__inner md-grid"> |
||||
|
||||
|
||||
<a href="awesome-big-data/" title="Awesome Big Data" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next"> |
||||
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> |
||||
<span class="md-flex__ellipsis"> |
||||
<span class="md-footer-nav__direction"> |
||||
Next |
||||
</span> |
||||
Awesome Big Data |
||||
</span> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i> |
||||
</div> |
||||
</a> |
||||
|
||||
</nav> |
||||
</div> |
||||
|
||||
<div class="md-footer-meta md-typeset"> |
||||
<div class="md-footer-meta__inner md-grid"> |
||||
<div class="md-footer-copyright"> |
||||
|
||||
<div class="md-footer-copyright__highlight"> |
||||
Copyright © 2018 Charles Reid, released under the <a href="https://opensource.org/licenses/BSD-3-Clause">BSD 3-Clause License</a> |
||||
</div> |
||||
|
||||
powered by |
||||
<a href="https://www.mkdocs.org">MkDocs</a> |
||||
and |
||||
<a href="https://squidfunk.github.io/mkdocs-material/"> |
||||
Material for MkDocs</a> |
||||
</div> |
||||
|
||||
|
||||
|
||||
</div> |
||||
</div> |
||||
</footer> |
||||
|
||||
</div> |
||||
|
||||
<script src="assets/javascripts/application.e72fd936.js"></script> |
||||
|
||||
<script>app.initialize({version:"1.0",url:{base:"."}})</script> |
||||
|
||||
<script src="search/main.js"></script> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body> |
||||
</html> |
||||
@ -1 +0,0 @@
@@ -1 +0,0 @@
|
||||
Subproject commit b0c6890853aa9138baf5f9749862b927518ab656 |
||||
@ -1,33 +0,0 @@
@@ -1,33 +0,0 @@
|
||||
site_name: search-demo-mkdocs-material |
||||
site_url: https://pages.charlesreid1.com/search-demo-mkdocs-material |
||||
repo_name: charlesreid1/search-demo-mkdocs-material |
||||
repo_url: https://git.charlesreid1.com/charlesreid1/search-demo-mkdocs-material |
||||
edit_uri: "" |
||||
|
||||
|
||||
copyright: 'Copyright © 2018 Charles Reid, released under the <a href="https://opensource.org/licenses/BSD-3-Clause">BSD 3-Clause License</a>' |
||||
|
||||
docs_dir: docs |
||||
site_dir: site |
||||
|
||||
theme: |
||||
|
||||
name: null |
||||
custom_dir: 'mkdocs-material/material' |
||||
|
||||
# pretty colors! see https://squidfunk.github.io/mkdocs-material/getting-started/#primary-colors |
||||
palette: |
||||
primary: 'dark blue' |
||||
accent: 'dark blue' |
||||
|
||||
# fun logos! see https://material.io/icons/ |
||||
logo: |
||||
icon: 'search' |
||||
|
||||
font: |
||||
text: 'Roboto' |
||||
code: 'Roboto Mono' |
||||
|
||||
# this will add docs/css/custom.css to all your docs |
||||
extra_css: |
||||
- css/custom.css |
||||
@ -0,0 +1,94 @@
@@ -0,0 +1,94 @@
|
||||
function getSearchTermFromLocation() { |
||||
var sPageURL = window.location.search.substring(1); |
||||
var sURLVariables = sPageURL.split('&'); |
||||
for (var i = 0; i < sURLVariables.length; i++) { |
||||
var sParameterName = sURLVariables[i].split('='); |
||||
if (sParameterName[0] == 'q') { |
||||
return decodeURIComponent(sParameterName[1].replace(/\+/g, '%20')); |
||||
} |
||||
} |
||||
} |
||||
|
||||
function formatResult (location, title, summary) { |
||||
return '<article><h3><a href="' + base_url + '/' + location + '">'+ title + '</a></h3><p>' + summary +'</p></article>'; |
||||
} |
||||
|
||||
function displayResults (results) { |
||||
var search_results = document.getElementById("mkdocs-search-results"); |
||||
while (search_results.firstChild) { |
||||
search_results.removeChild(search_results.firstChild); |
||||
} |
||||
if (results.length > 0){ |
||||
for (var i=0; i < results.length; i++){ |
||||
var result = results[i]; |
||||
var html = formatResult(result.location, result.title, result.summary); |
||||
search_results.insertAdjacentHTML('beforeend', html); |
||||
} |
||||
} else { |
||||
search_results.insertAdjacentHTML('beforeend', "<p>No results found</p>"); |
||||
} |
||||
} |
||||
|
||||
function doSearch () { |
||||
var query = document.getElementById('mkdocs-search-query').value; |
||||
if (query.length > 2) { |
||||
console.log('Searching with query: ' + query); |
||||
if (!window.Worker) { |
||||
displayResults(search(query)); |
||||
} else { |
||||
searchWorker.postMessage({query: query}); |
||||
} |
||||
} else { |
||||
// Clear results for short queries
|
||||
displayResults([]); |
||||
} |
||||
} |
||||
|
||||
function initSearch () { |
||||
var search_input = document.getElementById('mkdocs-search-query'); |
||||
if (search_input) { |
||||
search_input.addEventListener("keyup", doSearch); |
||||
} |
||||
|
||||
var term = getSearchTermFromLocation(); |
||||
if (term) { |
||||
search_input.value = term; |
||||
doSearch(); |
||||
} |
||||
} |
||||
|
||||
function onWorkerMessage (e) { |
||||
if (e.data.results) { |
||||
var results = e.data.results; |
||||
displayResults(results); |
||||
} |
||||
} |
||||
|
||||
if (!window.Worker) { |
||||
console.log('Web Worker API not supported'); |
||||
// load index in main thread
|
||||
$.getScript(base_url + "/search/worker.js").done(function () { |
||||
console.log('Loaded worker'); |
||||
init(); |
||||
}).fail(function (jqxhr, settings, exception) { |
||||
console.error('Could not load worker.js'); |
||||
}); |
||||
} else { |
||||
// Wrap search in a web worker
|
||||
var searchWorker = new Worker(base_url + "/search/worker.js"); |
||||
searchWorker.postMessage({init: true}); |
||||
searchWorker.onmessage = onWorkerMessage; |
||||
} |
||||
|
||||
$(function() { |
||||
var search_input = document.getElementById('mkdocs-search-query'); |
||||
if (search_input) { |
||||
search_input.addEventListener("keyup", doSearch); |
||||
} |
||||
|
||||
var term = getSearchTermFromLocation(); |
||||
if (term) { |
||||
search_input.value = term; |
||||
doSearch(); |
||||
} |
||||
}); |
||||
File diff suppressed because one or more lines are too long
@ -0,0 +1,127 @@
@@ -0,0 +1,127 @@
|
||||
var base_path = 'function' === typeof importScripts ? '.' : '/search/'; |
||||
var allowSearch = false; |
||||
var index; |
||||
var documents = {}; |
||||
var lang = ['en']; |
||||
var data; |
||||
|
||||
function getScript(script, callback) { |
||||
console.log('Loading script: ' + script); |
||||
$.getScript(base_path + script).done(function () { |
||||
callback(); |
||||
}).fail(function (jqxhr, settings, exception) { |
||||
console.log('Error: ' + exception); |
||||
}); |
||||
} |
||||
|
||||
function getScriptsInOrder(scripts, callback) { |
||||
if (scripts.length === 0) { |
||||
callback(); |
||||
return; |
||||
} |
||||
getScript(scripts[0], function() { |
||||
getScriptsInOrder(scripts.slice(1), callback); |
||||
}); |
||||
} |
||||
|
||||
function loadScripts(urls, callback) { |
||||
if( 'function' === typeof importScripts ) { |
||||
importScripts.apply(null, urls); |
||||
callback(); |
||||
} else { |
||||
getScriptsInOrder(urls, callback); |
||||
} |
||||
} |
||||
|
||||
function onJSONLoaded () { |
||||
data = JSON.parse(this.responseText); |
||||
var scriptsToLoad = ['lunr.js']; |
||||
if (data.config && data.config.lang && data.config.lang.length) { |
||||
lang = data.config.lang; |
||||
} |
||||
if (lang.length > 1 || lang[0] !== "en") { |
||||
scriptsToLoad.push('lunr.stemmer.support.js'); |
||||
if (lang.length > 1) { |
||||
scriptsToLoad.push('lunr.multi.js'); |
||||
} |
||||
for (var i=0; i < lang.length; i++) { |
||||
if (lang[i] != 'en') { |
||||
scriptsToLoad.push(['lunr', lang[i], 'js'].join('.')); |
||||
} |
||||
} |
||||
} |
||||
loadScripts(scriptsToLoad, onScriptsLoaded); |
||||
} |
||||
|
||||
function onScriptsLoaded () { |
||||
console.log('All search scripts loaded, building Lunr index...'); |
||||
if (data.config && data.config.separator && data.config.separator.length) { |
||||
lunr.tokenizer.separator = new RegExp(data.config.separator); |
||||
} |
||||
if (data.index) { |
||||
index = lunr.Index.load(data.index); |
||||
data.docs.forEach(function (doc) { |
||||
documents[doc.location] = doc; |
||||
}); |
||||
console.log('Lunr pre-built index loaded, search ready'); |
||||
} else { |
||||
index = lunr(function () { |
||||
if (lang.length === 1 && lang[0] !== "en" && lunr[lang[0]]) { |
||||
this.use(lunr[lang[0]]); |
||||
} else if (lang.length > 1) { |
||||
this.use(lunr.multiLanguage.apply(null, lang)); // spread operator not supported in all browsers: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Spread_operator#Browser_compatibility
|
||||
} |
||||
this.field('title'); |
||||
this.field('text'); |
||||
this.ref('location'); |
||||
|
||||
for (var i=0; i < data.docs.length; i++) { |
||||
var doc = data.docs[i]; |
||||
this.add(doc); |
||||
documents[doc.location] = doc; |
||||
} |
||||
}); |
||||
console.log('Lunr index built, search ready'); |
||||
} |
||||
allowSearch = true; |
||||
} |
||||
|
||||
function init () { |
||||
var oReq = new XMLHttpRequest(); |
||||
oReq.addEventListener("load", onJSONLoaded); |
||||
var index_path = base_path + '/search_index.json'; |
||||
if( 'function' === typeof importScripts ){ |
||||
index_path = 'search_index.json'; |
||||
} |
||||
oReq.open("GET", index_path); |
||||
oReq.send(); |
||||
} |
||||
|
||||
function search (query) { |
||||
if (!allowSearch) { |
||||
console.error('Assets for search still loading'); |
||||
return; |
||||
} |
||||
|
||||
var resultDocuments = []; |
||||
var results = index.search(query); |
||||
for (var i=0; i < results.length; i++){ |
||||
var result = results[i]; |
||||
doc = documents[result.ref]; |
||||
doc.summary = doc.text.substring(0, 200); |
||||
resultDocuments.push(doc); |
||||
} |
||||
return resultDocuments; |
||||
} |
||||
|
||||
if( 'function' === typeof importScripts ) { |
||||
onmessage = function (e) { |
||||
if (e.data.init) { |
||||
init(); |
||||
} else if (e.data.query) { |
||||
postMessage({ results: search(e.data.query) }); |
||||
} else { |
||||
console.error("Worker - Unrecognized message: " + e); |
||||
} |
||||
}; |
||||
} |
||||
@ -0,0 +1,38 @@
@@ -0,0 +1,38 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?> |
||||
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"> |
||||
<url> |
||||
<loc>https://pages.charlesreid1.com/search-demo-mkdocs-material/</loc> |
||||
<lastmod>2018-08-11</lastmod> |
||||
<changefreq>daily</changefreq> |
||||
</url> |
||||
<url> |
||||
<loc>https://pages.charlesreid1.com/search-demo-mkdocs-material/awesome-big-data/</loc> |
||||
<lastmod>2018-08-11</lastmod> |
||||
<changefreq>daily</changefreq> |
||||
</url> |
||||
<url> |
||||
<loc>https://pages.charlesreid1.com/search-demo-mkdocs-material/awesome-public-datasets/</loc> |
||||
<lastmod>2018-08-11</lastmod> |
||||
<changefreq>daily</changefreq> |
||||
</url> |
||||
<url> |
||||
<loc>https://pages.charlesreid1.com/search-demo-mkdocs-material/awesome-python/</loc> |
||||
<lastmod>2018-08-11</lastmod> |
||||
<changefreq>daily</changefreq> |
||||
</url> |
||||
<url> |
||||
<loc>https://pages.charlesreid1.com/search-demo-mkdocs-material/awesome-r/</loc> |
||||
<lastmod>2018-08-11</lastmod> |
||||
<changefreq>daily</changefreq> |
||||
</url> |
||||
<url> |
||||
<loc>https://pages.charlesreid1.com/search-demo-mkdocs-material/awesome-rest/</loc> |
||||
<lastmod>2018-08-11</lastmod> |
||||
<changefreq>daily</changefreq> |
||||
</url> |
||||
<url> |
||||
<loc>https://pages.charlesreid1.com/search-demo-mkdocs-material/awesome-vim/</loc> |
||||
<lastmod>2018-08-11</lastmod> |
||||
<changefreq>daily</changefreq> |
||||
</url> |
||||
</urlset> |
||||
Binary file not shown.
Loading…
Reference in new issue