Compare commits
No commits in common. 'master' and 'gh-pages' have entirely different histories.
54 changed files with 9228 additions and 344 deletions
@ -1,3 +0,0 @@
@@ -1,3 +0,0 @@
|
||||
[submodule "mkdocs-material"] |
||||
path = mkdocs-material |
||||
url = https://git.charlesreid1.com/charlesreid1/mkdocs-material |
||||
@ -1,11 +0,0 @@
@@ -1,11 +0,0 @@
|
||||
# how do I pandoc? |
||||
|
||||
A quick guide to doing useful things with pandoc, the swiss army knife for documents. |
||||
|
||||
See [how do I pandoc?](https://pages.charlesreid1.com/how-do-i-pandoc) |
||||
(the website). |
||||
|
||||
Source repository on git.charlesreid1.com [here](https://git.charlesreid1.com/charlesreid1/how-do-i-pandoc). |
||||
|
||||
Source repository on github [here](https://github.com/charlesreid1/how-do-i-pandoc). |
||||
|
||||
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
@ -0,0 +1,492 @@
@@ -0,0 +1,492 @@
|
||||
|
||||
|
||||
|
||||
|
||||
<!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/how-do-i-pandoc/converting/"> |
||||
|
||||
|
||||
|
||||
<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>Converting Text - how do I pandoc?</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="#3f51b5"> |
||||
|
||||
|
||||
|
||||
<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=Bitter:300,400,400i,700|PT+Mono"> |
||||
<style>body,input{font-family:"Bitter","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"PT 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="indigo" data-md-color-accent="indigo"> |
||||
|
||||
<svg class="md-svg"> |
||||
<defs> |
||||
|
||||
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="416" height="448" |
||||
viewBox="0 0 416 448" id="__github"> |
||||
<path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19-18.125 |
||||
8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19 18.125-8.5 |
||||
18.125 8.5 10.75 19 3.125 20.5zM320 304q0 10-3.125 20.5t-10.75 |
||||
19-18.125 8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19 |
||||
18.125-8.5 18.125 8.5 10.75 19 3.125 20.5zM360 |
||||
304q0-30-17.25-51t-46.75-21q-10.25 0-48.75 5.25-17.75 2.75-39.25 |
||||
2.75t-39.25-2.75q-38-5.25-48.75-5.25-29.5 0-46.75 21t-17.25 51q0 22 8 |
||||
38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0 |
||||
37.25-1.75t35-7.375 30.5-15 20.25-25.75 8-38.375zM416 260q0 51.75-15.25 |
||||
82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5-41.75 |
||||
1.125q-19.5 0-35.5-0.75t-36.875-3.125-38.125-7.5-34.25-12.875-30.25-20.25-21.5-28.75q-15.5-30.75-15.5-82.75 |
||||
0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25 |
||||
30.875q36.75-8.75 77.25-8.75 37 0 70 8 26.25-20.5 |
||||
46.75-30.25t47.25-9.75q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34 |
||||
99.5z" /> |
||||
</svg> |
||||
|
||||
</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="../#converting-text" 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/how-do-i-pandoc" title="how do I pandoc?" class="md-header-nav__button md-logo"> |
||||
|
||||
<i class="md-icon">help</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"> |
||||
how do I pandoc? |
||||
</span> |
||||
<span class="md-header-nav__topic"> |
||||
Converting Text |
||||
</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://github.com/charlesreid1/how-do-i-pandoc" title="Go to repository" class="md-source" data-md-source="github"> |
||||
|
||||
<div class="md-source__icon"> |
||||
<svg viewBox="0 0 24 24" width="24" height="24"> |
||||
<use xlink:href="#__github" width="24" height="24"></use> |
||||
</svg> |
||||
</div> |
||||
|
||||
<div class="md-source__repository"> |
||||
charlesreid1/how-do-i-pandoc |
||||
</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/how-do-i-pandoc" title="how do I pandoc?" class="md-nav__button md-logo"> |
||||
|
||||
<i class="md-icon">help</i> |
||||
|
||||
</a> |
||||
how do I pandoc? |
||||
</label> |
||||
|
||||
<div class="md-nav__source"> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a href="https://github.com/charlesreid1/how-do-i-pandoc" title="Go to repository" class="md-source" data-md-source="github"> |
||||
|
||||
<div class="md-source__icon"> |
||||
<svg viewBox="0 0 24 24" width="24" height="24"> |
||||
<use xlink:href="#__github" width="24" height="24"></use> |
||||
</svg> |
||||
</div> |
||||
|
||||
<div class="md-source__repository"> |
||||
charlesreid1/how-do-i-pandoc |
||||
</div> |
||||
</a> |
||||
|
||||
</div> |
||||
|
||||
<ul class="md-nav__list" data-md-scrollfix> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href=".." title="Index" class="md-nav__link"> |
||||
Index |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item md-nav__item--active"> |
||||
|
||||
<input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc"> |
||||
|
||||
|
||||
<label class="md-nav__link md-nav__link--active" for="__toc"> |
||||
Converting Text |
||||
</label> |
||||
|
||||
<a href="./" title="Converting Text" class="md-nav__link md-nav__link--active"> |
||||
Converting Text |
||||
</a> |
||||
|
||||
|
||||
<nav class="md-nav md-nav--secondary"> |
||||
|
||||
|
||||
|
||||
<label class="md-nav__title" for="__toc">Table of contents</label> |
||||
<ul class="md-nav__list" data-md-scrollfix> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#converting-text" title="Converting Text" class="md-nav__link"> |
||||
Converting Text |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</ul> |
||||
|
||||
</nav> |
||||
|
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../filtering_pre/" title="Filtering with Pre-Written Filters" class="md-nav__link"> |
||||
Filtering with Pre-Written Filters |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../filtering_custom/" title="Filtering with Custom Filters" class="md-nav__link"> |
||||
Filtering with Custom Filters |
||||
</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"> |
||||
|
||||
|
||||
|
||||
<label class="md-nav__title" for="__toc">Table of contents</label> |
||||
<ul class="md-nav__list" data-md-scrollfix> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#converting-text" title="Converting Text" class="md-nav__link"> |
||||
Converting Text |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</ul> |
||||
|
||||
</nav> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
|
||||
|
||||
<div class="md-content"> |
||||
<article class="md-content__inner md-typeset"> |
||||
|
||||
|
||||
|
||||
<h1>Converting Text</h1> |
||||
|
||||
<h2 id="converting-text">Converting Text<a class="headerlink" href="#converting-text" title="Permanent link">¶</a></h2> |
||||
<p>To use pandoc to convert text, specify an output file, then feed it input files. |
||||
You can also specify input and output formats, and use some basic pandoc flags |
||||
to control how the process goes.</p> |
||||
<p>To specify an output file, use the <code>-o</code> or <code>--output</code> flag.</p> |
||||
<p>All other file names passed on the command line are interpreted as input files.</p> |
||||
<p>For example, to convert text to HTML, we can either convert the text |
||||
into a fragment of HTML, or into a full, standalone document using the <code>-s</code> |
||||
or <code>--standalone</code> flag:</p> |
||||
<div class="codehilite"><pre><span></span>$ pandoc -o output.html input.txt # generate a fragment of html |
||||
$ pandoc -s -o output.html input.txt # generate a standalone html document |
||||
</pre></div> |
||||
|
||||
|
||||
<p>To specify formats, use the <code>-t</code> or <code>--to</code> flag, and the <code>-f</code> or <code>--from</code> flag. |
||||
For example, converting from Github-flavored Markdown (gfm) to HTML looks like:</p> |
||||
<div class="codehilite"><pre><span></span>$ pandoc -f gfm -t html -o my_cool_html_file.html my_cool_markdown_file.md |
||||
</pre></div> |
||||
|
||||
|
||||
<p>See <a href="http://pandoc.org/MANUAL.html#options">list of formats</a>.</p> |
||||
<p>If no output file is specified, output will go to stdout. |
||||
This enables pandoc to be chained together with other tools |
||||
into pipelines.</p> |
||||
<p>In that spirit, input to pandoc can also come from stdin. |
||||
To make pandoc a component of a data pipeline, simply feed |
||||
input from stdin and pipe output from stdout:</p> |
||||
<div class="codehilite"><pre><span></span>$ cat my_cool_markdown_file.md | pandoc -f gfm -t html | ... |
||||
</pre></div> |
||||
|
||||
|
||||
<p>We can also generate and convert documents on the fly from the command line:</p> |
||||
<div class="codehilite"><pre><span></span>$ echo "# Hello World |
||||
|
||||
[this is the earth](https://earth.com)" | pandoc -f gfm -t html |
||||
|
||||
<h1 id="hello-world">Hello World</h1> |
||||
<p><a href="https://earth.com">this is the earth</a></p> |
||||
</pre></div> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article> |
||||
</div> |
||||
</div> |
||||
</main> |
||||
|
||||
|
||||
<footer class="md-footer"> |
||||
|
||||
<div class="md-footer-nav"> |
||||
<nav class="md-footer-nav__inner md-grid"> |
||||
|
||||
<a href=".." title="Index" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev"> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<i class="md-icon md-icon--arrow-back md-footer-nav__button"></i> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> |
||||
<span class="md-flex__ellipsis"> |
||||
<span class="md-footer-nav__direction"> |
||||
Previous |
||||
</span> |
||||
Index |
||||
</span> |
||||
</div> |
||||
</a> |
||||
|
||||
|
||||
<a href="../filtering_pre/" title="Filtering with Pre-Written Filters" 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> |
||||
Filtering with Pre-Written Filters |
||||
</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 <a href="https://charlesreid1.com">Charles Reid</a>, released under the <a href="https://opensource.org/licenses/MIT">MIT 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,51 +0,0 @@
@@ -1,51 +0,0 @@
|
||||
## Converting Text |
||||
|
||||
To use pandoc to convert text, specify an output file, then feed it input files. |
||||
You can also specify input and output formats, and use some basic pandoc flags |
||||
to control how the process goes. |
||||
|
||||
To specify an output file, use the `-o` or `--output` flag. |
||||
|
||||
All other file names passed on the command line are interpreted as input files. |
||||
|
||||
For example, to convert text to HTML, we can either convert the text |
||||
into a fragment of HTML, or into a full, standalone document using the `-s` |
||||
or `--standalone` flag: |
||||
|
||||
``` |
||||
$ pandoc -o output.html input.txt # generate a fragment of html |
||||
$ pandoc -s -o output.html input.txt # generate a standalone html document |
||||
``` |
||||
|
||||
To specify formats, use the `-t` or `--to` flag, and the `-f` or `--from` flag. |
||||
For example, converting from Github-flavored Markdown (gfm) to HTML looks like: |
||||
|
||||
``` |
||||
$ pandoc -f gfm -t html -o my_cool_html_file.html my_cool_markdown_file.md |
||||
``` |
||||
|
||||
See [list of formats](http://pandoc.org/MANUAL.html#options). |
||||
|
||||
If no output file is specified, output will go to stdout. |
||||
This enables pandoc to be chained together with other tools |
||||
into pipelines. |
||||
|
||||
In that spirit, input to pandoc can also come from stdin. |
||||
To make pandoc a component of a data pipeline, simply feed |
||||
input from stdin and pipe output from stdout: |
||||
|
||||
``` |
||||
$ cat my_cool_markdown_file.md | pandoc -f gfm -t html | ... |
||||
``` |
||||
|
||||
We can also generate and convert documents on the fly from the command line: |
||||
|
||||
```plain |
||||
$ echo "# Hello World |
||||
|
||||
[this is the earth](https://earth.com)" | pandoc -f gfm -t html |
||||
|
||||
<h1 id="hello-world">Hello World</h1> |
||||
<p><a href="https://earth.com">this is the earth</a></p> |
||||
``` |
||||
|
||||
@ -1,131 +0,0 @@
@@ -1,131 +0,0 @@
|
||||
## Filtering Text with Custom Filters |
||||
|
||||
This guide will skip most of the details of |
||||
writing custom filters, since it would rapidly |
||||
expand the scope of this tutorial. |
||||
|
||||
However, we include a few notes about how custom |
||||
filters work and how to apply them. |
||||
|
||||
## How Custom Filters Work |
||||
|
||||
`pandoc` converts every document, regardless of structure, |
||||
into a universal JSON document structure. This is what |
||||
enables it to convert among formats, and it is also where |
||||
any document filters are applied. |
||||
|
||||
To illustrate: imagine we have some abstract custom filter |
||||
called `foobar` that will make all bold text underlined |
||||
(for example), and we are applying it when converting |
||||
from Markdown to HTML. |
||||
|
||||
The process to apply this filter is as follows: |
||||
|
||||
``` |
||||
Input fmt --(pandoc)--> JSON -- Filter --> JSON --(pandoc)--> Output fmt |
||||
``` |
||||
|
||||
In practice, we can create this pipeline on the |
||||
command line, or from Python. |
||||
|
||||
Also note, it is important to use pandoc with the `-s` |
||||
(standalone document) flag. |
||||
|
||||
## Writing Custom Filters |
||||
|
||||
See [this example](https://github.com/sergiocorreia/panflute/blob/master/docs/source/_static/fenced-template.py) |
||||
for a Panflute filter template. |
||||
|
||||
The important parts of a pandoc filter are: |
||||
|
||||
* **Prepare function** - run once, before the document is filtered. This is |
||||
useful for initializing lists, dictionaries, or files. |
||||
|
||||
* **Finalize function** - run once, after the document has been filtered. |
||||
This is useful for doing something with information extracted from |
||||
the document. |
||||
|
||||
* **Filter actions** - these functions are run once for each chunk of text. |
||||
Each filter action is passed a chunk of text in. |
||||
If a filter action returns nothing, the section of text is left unmodified. |
||||
Otherwise, the (filtered) text returned by the function is used in its place. |
||||
There can be multiple filter actions per document. |
||||
|
||||
* **Main function** - this is where the filter is actually applied. |
||||
|
||||
Here is a barebones filter: |
||||
|
||||
``` |
||||
def main(doc=None): |
||||
return pf.run_filter(action, |
||||
prepare=prepare, |
||||
finalize=finalize, |
||||
doc=doc) |
||||
|
||||
def prepare(doc): |
||||
pass |
||||
|
||||
def action(elem, doc): |
||||
pass |
||||
|
||||
def finalize(doc): |
||||
pass |
||||
|
||||
if __name__=="__main__": |
||||
main() |
||||
``` |
||||
|
||||
## Using Custom Filters |
||||
|
||||
### Command Line |
||||
|
||||
Following the example above, let us apply a filter |
||||
while converting `index.md` from github flavored markdown |
||||
to HTML. |
||||
|
||||
Start with the initial step, which is markdown to JSON |
||||
(include the `-s` flag): |
||||
|
||||
``` |
||||
$ cat index.md | pandoc -s -f gfm -t json |
||||
``` |
||||
|
||||
Now this JSON is passed through a filter, |
||||
which also returns JSON (more details below). |
||||
If we have a `panflute` filter that is in the |
||||
file `foobar.py`, it will take JSON input |
||||
and return JSON output. We use it like this: |
||||
|
||||
``` |
||||
$ cat index.md | pandoc -s -f gfm -t json | python foobar.py |
||||
``` |
||||
|
||||
This will output filtered JSON text. (More on the |
||||
filter itself in a moment.) |
||||
|
||||
The output from the filter `foobar.py` can now be passed to |
||||
another Pandoc process and converted to a document in the same |
||||
or a different format: |
||||
|
||||
``` |
||||
$ cat index.md | pandoc -s -f gfm -t json | python foobar.py | pandoc -s -f json -t html -o index.html |
||||
``` |
||||
|
||||
Lastly, if we make `foobar.py` into an executable file called `foobar` |
||||
by adding the header `#!/usr/bin/env python` and `chmod +x foobar`, |
||||
we can use it as follows: |
||||
|
||||
``` |
||||
$ cat index.md | pandoc -s -f gfm -t json | foobar | pandoc -s -f json -t html -o index.html |
||||
``` |
||||
|
||||
|
||||
### Pypandoc |
||||
|
||||
Custom filters can also be applied using [pypandoc](https://github.com/bebraw/pypandoc), |
||||
a thin Python wrapper for the Pandoc command line client. |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,56 +0,0 @@
@@ -1,56 +0,0 @@
|
||||
## Filtering Text with Pre-Written Filters |
||||
|
||||
Pandoc has multiple command line options that |
||||
apply some useful pre-written filters. |
||||
|
||||
For a list, just run `pandoc --help`. |
||||
|
||||
Here we cover the most useful filters, and how to use them. |
||||
Here are a few example filters: |
||||
|
||||
``` |
||||
$ pandoc --help |
||||
pandoc [OPTIONS] [FILES] |
||||
--strip-empty-paragraphs |
||||
--extract-media=PATH |
||||
--eol=crlf|lf|native |
||||
--wrap=auto|none|preserve |
||||
--columns=NUMBER |
||||
--strip-comments |
||||
--toc, --table-of-contents |
||||
--toc-depth=NUMBER |
||||
--no-highlight |
||||
--highlight-style=STYLE|FILE |
||||
--syntax-definition=FILE |
||||
--reference-links |
||||
--reference-location=block|section|document |
||||
--default-image-extension=extension |
||||
--email-obfuscation=none|javascript|references |
||||
``` |
||||
|
||||
|
||||
### Extracting Media |
||||
|
||||
A useful filter is the extract media filter. |
||||
This filter is applied by adding a command line |
||||
flag to the pandoc call: |
||||
|
||||
```plain |
||||
$ pandoc --extract-media=doc1_media doc1.docx |
||||
``` |
||||
|
||||
This creates a folder next to `doc1.docx` |
||||
with the following structure: |
||||
|
||||
```plain |
||||
$ ls -R |
||||
doc1.docx |
||||
doc1_media |
||||
|
||||
./doc1_media: |
||||
media |
||||
|
||||
./doc1_media/media: |
||||
embedded_image.png |
||||
``` |
||||
|
||||
@ -1,50 +0,0 @@
@@ -1,50 +0,0 @@
|
||||
# How Do I Pandoc? |
||||
|
||||
A simple explanation of how to use pandoc, the C-3PO of documents. |
||||
|
||||
Pandoc is a command line tool written in Haskell. It knows many different |
||||
dialects of document, so it is capable of extracting the content of |
||||
documents in one format and converting them into another format. |
||||
|
||||
Some examples: markdown, github-flavored markdown, reStructured text, |
||||
HTML, docx, OpenOffice.Org document format, etc. |
||||
|
||||
It is also possible to write filters for pandoc to process text |
||||
in customized ways (e.g., extract all links in a document, or |
||||
create a table of contents, or turn bold text into strikethrough |
||||
text). |
||||
|
||||
|
||||
## Installing |
||||
|
||||
Available through most package managers. See [installing pandoc](http://www.pandoc.org/installing.html) |
||||
page in the pandoc documentation. |
||||
|
||||
``` |
||||
$ brew install pandoc |
||||
|
||||
$ apt-get install pandoc |
||||
``` |
||||
|
||||
## Quickstart |
||||
|
||||
There is a nice [getting started guide](http://pandoc.org/getting-started.html) |
||||
in the pandoc documentation for those unfamiliar with command-line tools. |
||||
|
||||
There is also a [user's guide](http://pandoc.org/MANUAL.html) that shows |
||||
basic usage of pandoc as a command line tool. |
||||
|
||||
## Common Operations |
||||
|
||||
There are a few common operations with pandoc: |
||||
|
||||
* [Converting text](converting.md) from one format to another (basic) |
||||
* [Filtering text with pre-written filters](filtering_pre.md) (intermediate) |
||||
* [Filtering text with custom filters](filtering_custom.md) (advanced) |
||||
* Some combination of above |
||||
|
||||
There are two ways to use pandoc, covered in each section: |
||||
|
||||
* Pandoc command line tool - `pandoc` command |
||||
* Pypandoc API wrapper - [`pypandoc`](https://github.com/bebraw/pypandoc) library |
||||
|
||||
@ -0,0 +1,630 @@
@@ -0,0 +1,630 @@
|
||||
|
||||
|
||||
|
||||
|
||||
<!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/how-do-i-pandoc/filtering_custom/"> |
||||
|
||||
|
||||
|
||||
<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>Filtering with Custom Filters - how do I pandoc?</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="#3f51b5"> |
||||
|
||||
|
||||
|
||||
<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=Bitter:300,400,400i,700|PT+Mono"> |
||||
<style>body,input{font-family:"Bitter","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"PT 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="indigo" data-md-color-accent="indigo"> |
||||
|
||||
<svg class="md-svg"> |
||||
<defs> |
||||
|
||||
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="416" height="448" |
||||
viewBox="0 0 416 448" id="__github"> |
||||
<path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19-18.125 |
||||
8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19 18.125-8.5 |
||||
18.125 8.5 10.75 19 3.125 20.5zM320 304q0 10-3.125 20.5t-10.75 |
||||
19-18.125 8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19 |
||||
18.125-8.5 18.125 8.5 10.75 19 3.125 20.5zM360 |
||||
304q0-30-17.25-51t-46.75-21q-10.25 0-48.75 5.25-17.75 2.75-39.25 |
||||
2.75t-39.25-2.75q-38-5.25-48.75-5.25-29.5 0-46.75 21t-17.25 51q0 22 8 |
||||
38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0 |
||||
37.25-1.75t35-7.375 30.5-15 20.25-25.75 8-38.375zM416 260q0 51.75-15.25 |
||||
82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5-41.75 |
||||
1.125q-19.5 0-35.5-0.75t-36.875-3.125-38.125-7.5-34.25-12.875-30.25-20.25-21.5-28.75q-15.5-30.75-15.5-82.75 |
||||
0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25 |
||||
30.875q36.75-8.75 77.25-8.75 37 0 70 8 26.25-20.5 |
||||
46.75-30.25t47.25-9.75q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34 |
||||
99.5z" /> |
||||
</svg> |
||||
|
||||
</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="../#filtering-text-with-custom-filters" 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/how-do-i-pandoc" title="how do I pandoc?" class="md-header-nav__button md-logo"> |
||||
|
||||
<i class="md-icon">help</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"> |
||||
how do I pandoc? |
||||
</span> |
||||
<span class="md-header-nav__topic"> |
||||
Filtering with Custom Filters |
||||
</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://github.com/charlesreid1/how-do-i-pandoc" title="Go to repository" class="md-source" data-md-source="github"> |
||||
|
||||
<div class="md-source__icon"> |
||||
<svg viewBox="0 0 24 24" width="24" height="24"> |
||||
<use xlink:href="#__github" width="24" height="24"></use> |
||||
</svg> |
||||
</div> |
||||
|
||||
<div class="md-source__repository"> |
||||
charlesreid1/how-do-i-pandoc |
||||
</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/how-do-i-pandoc" title="how do I pandoc?" class="md-nav__button md-logo"> |
||||
|
||||
<i class="md-icon">help</i> |
||||
|
||||
</a> |
||||
how do I pandoc? |
||||
</label> |
||||
|
||||
<div class="md-nav__source"> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a href="https://github.com/charlesreid1/how-do-i-pandoc" title="Go to repository" class="md-source" data-md-source="github"> |
||||
|
||||
<div class="md-source__icon"> |
||||
<svg viewBox="0 0 24 24" width="24" height="24"> |
||||
<use xlink:href="#__github" width="24" height="24"></use> |
||||
</svg> |
||||
</div> |
||||
|
||||
<div class="md-source__repository"> |
||||
charlesreid1/how-do-i-pandoc |
||||
</div> |
||||
</a> |
||||
|
||||
</div> |
||||
|
||||
<ul class="md-nav__list" data-md-scrollfix> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href=".." title="Index" class="md-nav__link"> |
||||
Index |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../converting/" title="Converting Text" class="md-nav__link"> |
||||
Converting Text |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../filtering_pre/" title="Filtering with Pre-Written Filters" class="md-nav__link"> |
||||
Filtering with Pre-Written Filters |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item md-nav__item--active"> |
||||
|
||||
<input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc"> |
||||
|
||||
|
||||
<label class="md-nav__link md-nav__link--active" for="__toc"> |
||||
Filtering with Custom Filters |
||||
</label> |
||||
|
||||
<a href="./" title="Filtering with Custom Filters" class="md-nav__link md-nav__link--active"> |
||||
Filtering with Custom Filters |
||||
</a> |
||||
|
||||
|
||||
<nav class="md-nav md-nav--secondary"> |
||||
|
||||
|
||||
|
||||
<label class="md-nav__title" for="__toc">Table of contents</label> |
||||
<ul class="md-nav__list" data-md-scrollfix> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#filtering-text-with-custom-filters" title="Filtering Text with Custom Filters" class="md-nav__link"> |
||||
Filtering Text with Custom Filters |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#how-custom-filters-work" title="How Custom Filters Work" class="md-nav__link"> |
||||
How Custom Filters Work |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#writing-custom-filters" title="Writing Custom Filters" class="md-nav__link"> |
||||
Writing Custom Filters |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#using-custom-filters" title="Using Custom Filters" class="md-nav__link"> |
||||
Using Custom Filters |
||||
</a> |
||||
|
||||
<nav class="md-nav"> |
||||
<ul class="md-nav__list"> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#command-line" title="Command Line" class="md-nav__link"> |
||||
Command Line |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#pypandoc" title="Pypandoc" class="md-nav__link"> |
||||
Pypandoc |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
</ul> |
||||
</nav> |
||||
|
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</ul> |
||||
|
||||
</nav> |
||||
|
||||
</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"> |
||||
|
||||
|
||||
|
||||
<label class="md-nav__title" for="__toc">Table of contents</label> |
||||
<ul class="md-nav__list" data-md-scrollfix> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#filtering-text-with-custom-filters" title="Filtering Text with Custom Filters" class="md-nav__link"> |
||||
Filtering Text with Custom Filters |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#how-custom-filters-work" title="How Custom Filters Work" class="md-nav__link"> |
||||
How Custom Filters Work |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#writing-custom-filters" title="Writing Custom Filters" class="md-nav__link"> |
||||
Writing Custom Filters |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#using-custom-filters" title="Using Custom Filters" class="md-nav__link"> |
||||
Using Custom Filters |
||||
</a> |
||||
|
||||
<nav class="md-nav"> |
||||
<ul class="md-nav__list"> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#command-line" title="Command Line" class="md-nav__link"> |
||||
Command Line |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#pypandoc" title="Pypandoc" class="md-nav__link"> |
||||
Pypandoc |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
</ul> |
||||
</nav> |
||||
|
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</ul> |
||||
|
||||
</nav> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
|
||||
|
||||
<div class="md-content"> |
||||
<article class="md-content__inner md-typeset"> |
||||
|
||||
|
||||
|
||||
<h1>Filtering with Custom Filters</h1> |
||||
|
||||
<h2 id="filtering-text-with-custom-filters">Filtering Text with Custom Filters<a class="headerlink" href="#filtering-text-with-custom-filters" title="Permanent link">¶</a></h2> |
||||
<p>This guide will skip most of the details of |
||||
writing custom filters, since it would rapidly |
||||
expand the scope of this tutorial.</p> |
||||
<p>However, we include a few notes about how custom |
||||
filters work and how to apply them.</p> |
||||
<h2 id="how-custom-filters-work">How Custom Filters Work<a class="headerlink" href="#how-custom-filters-work" title="Permanent link">¶</a></h2> |
||||
<p><code>pandoc</code> converts every document, regardless of structure, |
||||
into a universal JSON document structure. This is what |
||||
enables it to convert among formats, and it is also where |
||||
any document filters are applied.</p> |
||||
<p>To illustrate: imagine we have some abstract custom filter |
||||
called <code>foobar</code> that will make all bold text underlined |
||||
(for example), and we are applying it when converting |
||||
from Markdown to HTML.</p> |
||||
<p>The process to apply this filter is as follows:</p> |
||||
<div class="codehilite"><pre><span></span>Input fmt --(pandoc)--> JSON -- Filter --> JSON --(pandoc)--> Output fmt |
||||
</pre></div> |
||||
|
||||
|
||||
<p>In practice, we can create this pipeline on the |
||||
command line, or from Python.</p> |
||||
<p>Also note, it is important to use pandoc with the <code>-s</code> |
||||
(standalone document) flag.</p> |
||||
<h2 id="writing-custom-filters">Writing Custom Filters<a class="headerlink" href="#writing-custom-filters" title="Permanent link">¶</a></h2> |
||||
<p>See <a href="https://github.com/sergiocorreia/panflute/blob/master/docs/source/_static/fenced-template.py">this example</a> |
||||
for a Panflute filter template.</p> |
||||
<p>The important parts of a pandoc filter are:</p> |
||||
<ul> |
||||
<li> |
||||
<p><strong>Prepare function</strong> - run once, before the document is filtered. This is |
||||
useful for initializing lists, dictionaries, or files.</p> |
||||
</li> |
||||
<li> |
||||
<p><strong>Finalize function</strong> - run once, after the document has been filtered. |
||||
This is useful for doing something with information extracted from |
||||
the document.</p> |
||||
</li> |
||||
<li> |
||||
<p><strong>Filter actions</strong> - these functions are run once for each chunk of text. |
||||
Each filter action is passed a chunk of text in. |
||||
If a filter action returns nothing, the section of text is left unmodified. |
||||
Otherwise, the (filtered) text returned by the function is used in its place. |
||||
There can be multiple filter actions per document. </p> |
||||
</li> |
||||
<li> |
||||
<p><strong>Main function</strong> - this is where the filter is actually applied.</p> |
||||
</li> |
||||
</ul> |
||||
<p>Here is a barebones filter:</p> |
||||
<div class="codehilite"><pre><span></span>def main(doc=None): |
||||
return pf.run_filter(action, |
||||
prepare=prepare, |
||||
finalize=finalize, |
||||
doc=doc) |
||||
|
||||
def prepare(doc): |
||||
pass |
||||
|
||||
def action(elem, doc): |
||||
pass |
||||
|
||||
def finalize(doc): |
||||
pass |
||||
|
||||
if __name__=="__main__": |
||||
main() |
||||
</pre></div> |
||||
|
||||
|
||||
<h2 id="using-custom-filters">Using Custom Filters<a class="headerlink" href="#using-custom-filters" title="Permanent link">¶</a></h2> |
||||
<h3 id="command-line">Command Line<a class="headerlink" href="#command-line" title="Permanent link">¶</a></h3> |
||||
<p>Following the example above, let us apply a filter |
||||
while converting <code>index.md</code> from github flavored markdown |
||||
to HTML.</p> |
||||
<p>Start with the initial step, which is markdown to JSON |
||||
(include the <code>-s</code> flag):</p> |
||||
<div class="codehilite"><pre><span></span>$ cat index.md | pandoc -s -f gfm -t json |
||||
</pre></div> |
||||
|
||||
|
||||
<p>Now this JSON is passed through a filter, |
||||
which also returns JSON (more details below). |
||||
If we have a <code>panflute</code> filter that is in the |
||||
file <code>foobar.py</code>, it will take JSON input |
||||
and return JSON output. We use it like this:</p> |
||||
<div class="codehilite"><pre><span></span>$ cat index.md | pandoc -s -f gfm -t json | python foobar.py |
||||
</pre></div> |
||||
|
||||
|
||||
<p>This will output filtered JSON text. (More on the |
||||
filter itself in a moment.)</p> |
||||
<p>The output from the filter <code>foobar.py</code> can now be passed to |
||||
another Pandoc process and converted to a document in the same |
||||
or a different format:</p> |
||||
<div class="codehilite"><pre><span></span>$ cat index.md | pandoc -s -f gfm -t json | python foobar.py | pandoc -s -f json -t html -o index.html |
||||
</pre></div> |
||||
|
||||
|
||||
<p>Lastly, if we make <code>foobar.py</code> into an executable file called <code>foobar</code> |
||||
by adding the header <code>#!/usr/bin/env python</code> and <code>chmod +x foobar</code>, |
||||
we can use it as follows:</p> |
||||
<div class="codehilite"><pre><span></span>$ cat index.md | pandoc -s -f gfm -t json | foobar | pandoc -s -f json -t html -o index.html |
||||
</pre></div> |
||||
|
||||
|
||||
<h3 id="pypandoc">Pypandoc<a class="headerlink" href="#pypandoc" title="Permanent link">¶</a></h3> |
||||
<p>Custom filters can also be applied using <a href="https://github.com/bebraw/pypandoc">pypandoc</a>, |
||||
a thin Python wrapper for the Pandoc command line client.</p> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article> |
||||
</div> |
||||
</div> |
||||
</main> |
||||
|
||||
|
||||
<footer class="md-footer"> |
||||
|
||||
<div class="md-footer-nav"> |
||||
<nav class="md-footer-nav__inner md-grid"> |
||||
|
||||
<a href="../filtering_pre/" title="Filtering with Pre-Written Filters" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev"> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<i class="md-icon md-icon--arrow-back md-footer-nav__button"></i> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> |
||||
<span class="md-flex__ellipsis"> |
||||
<span class="md-footer-nav__direction"> |
||||
Previous |
||||
</span> |
||||
Filtering with Pre-Written Filters |
||||
</span> |
||||
</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 <a href="https://charlesreid1.com">Charles Reid</a>, released under the <a href="https://opensource.org/licenses/MIT">MIT 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> |
||||
@ -0,0 +1,525 @@
@@ -0,0 +1,525 @@
|
||||
|
||||
|
||||
|
||||
|
||||
<!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/how-do-i-pandoc/filtering_pre/"> |
||||
|
||||
|
||||
|
||||
<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>Filtering with Pre-Written Filters - how do I pandoc?</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="#3f51b5"> |
||||
|
||||
|
||||
|
||||
<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=Bitter:300,400,400i,700|PT+Mono"> |
||||
<style>body,input{font-family:"Bitter","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"PT 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="indigo" data-md-color-accent="indigo"> |
||||
|
||||
<svg class="md-svg"> |
||||
<defs> |
||||
|
||||
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="416" height="448" |
||||
viewBox="0 0 416 448" id="__github"> |
||||
<path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19-18.125 |
||||
8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19 18.125-8.5 |
||||
18.125 8.5 10.75 19 3.125 20.5zM320 304q0 10-3.125 20.5t-10.75 |
||||
19-18.125 8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19 |
||||
18.125-8.5 18.125 8.5 10.75 19 3.125 20.5zM360 |
||||
304q0-30-17.25-51t-46.75-21q-10.25 0-48.75 5.25-17.75 2.75-39.25 |
||||
2.75t-39.25-2.75q-38-5.25-48.75-5.25-29.5 0-46.75 21t-17.25 51q0 22 8 |
||||
38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0 |
||||
37.25-1.75t35-7.375 30.5-15 20.25-25.75 8-38.375zM416 260q0 51.75-15.25 |
||||
82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5-41.75 |
||||
1.125q-19.5 0-35.5-0.75t-36.875-3.125-38.125-7.5-34.25-12.875-30.25-20.25-21.5-28.75q-15.5-30.75-15.5-82.75 |
||||
0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25 |
||||
30.875q36.75-8.75 77.25-8.75 37 0 70 8 26.25-20.5 |
||||
46.75-30.25t47.25-9.75q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34 |
||||
99.5z" /> |
||||
</svg> |
||||
|
||||
</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="../#filtering-text-with-pre-written-filters" 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/how-do-i-pandoc" title="how do I pandoc?" class="md-header-nav__button md-logo"> |
||||
|
||||
<i class="md-icon">help</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"> |
||||
how do I pandoc? |
||||
</span> |
||||
<span class="md-header-nav__topic"> |
||||
Filtering with Pre-Written Filters |
||||
</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://github.com/charlesreid1/how-do-i-pandoc" title="Go to repository" class="md-source" data-md-source="github"> |
||||
|
||||
<div class="md-source__icon"> |
||||
<svg viewBox="0 0 24 24" width="24" height="24"> |
||||
<use xlink:href="#__github" width="24" height="24"></use> |
||||
</svg> |
||||
</div> |
||||
|
||||
<div class="md-source__repository"> |
||||
charlesreid1/how-do-i-pandoc |
||||
</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/how-do-i-pandoc" title="how do I pandoc?" class="md-nav__button md-logo"> |
||||
|
||||
<i class="md-icon">help</i> |
||||
|
||||
</a> |
||||
how do I pandoc? |
||||
</label> |
||||
|
||||
<div class="md-nav__source"> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a href="https://github.com/charlesreid1/how-do-i-pandoc" title="Go to repository" class="md-source" data-md-source="github"> |
||||
|
||||
<div class="md-source__icon"> |
||||
<svg viewBox="0 0 24 24" width="24" height="24"> |
||||
<use xlink:href="#__github" width="24" height="24"></use> |
||||
</svg> |
||||
</div> |
||||
|
||||
<div class="md-source__repository"> |
||||
charlesreid1/how-do-i-pandoc |
||||
</div> |
||||
</a> |
||||
|
||||
</div> |
||||
|
||||
<ul class="md-nav__list" data-md-scrollfix> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href=".." title="Index" class="md-nav__link"> |
||||
Index |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../converting/" title="Converting Text" class="md-nav__link"> |
||||
Converting Text |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item md-nav__item--active"> |
||||
|
||||
<input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc"> |
||||
|
||||
|
||||
<label class="md-nav__link md-nav__link--active" for="__toc"> |
||||
Filtering with Pre-Written Filters |
||||
</label> |
||||
|
||||
<a href="./" title="Filtering with Pre-Written Filters" class="md-nav__link md-nav__link--active"> |
||||
Filtering with Pre-Written Filters |
||||
</a> |
||||
|
||||
|
||||
<nav class="md-nav md-nav--secondary"> |
||||
|
||||
|
||||
|
||||
<label class="md-nav__title" for="__toc">Table of contents</label> |
||||
<ul class="md-nav__list" data-md-scrollfix> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#filtering-text-with-pre-written-filters" title="Filtering Text with Pre-Written Filters" class="md-nav__link"> |
||||
Filtering Text with Pre-Written Filters |
||||
</a> |
||||
|
||||
<nav class="md-nav"> |
||||
<ul class="md-nav__list"> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#extracting-media" title="Extracting Media" class="md-nav__link"> |
||||
Extracting Media |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
</ul> |
||||
</nav> |
||||
|
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</ul> |
||||
|
||||
</nav> |
||||
|
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="../filtering_custom/" title="Filtering with Custom Filters" class="md-nav__link"> |
||||
Filtering with Custom Filters |
||||
</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"> |
||||
|
||||
|
||||
|
||||
<label class="md-nav__title" for="__toc">Table of contents</label> |
||||
<ul class="md-nav__list" data-md-scrollfix> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#filtering-text-with-pre-written-filters" title="Filtering Text with Pre-Written Filters" class="md-nav__link"> |
||||
Filtering Text with Pre-Written Filters |
||||
</a> |
||||
|
||||
<nav class="md-nav"> |
||||
<ul class="md-nav__list"> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#extracting-media" title="Extracting Media" class="md-nav__link"> |
||||
Extracting Media |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
</ul> |
||||
</nav> |
||||
|
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</ul> |
||||
|
||||
</nav> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
|
||||
|
||||
<div class="md-content"> |
||||
<article class="md-content__inner md-typeset"> |
||||
|
||||
|
||||
|
||||
<h1>Filtering with Pre-Written Filters</h1> |
||||
|
||||
<h2 id="filtering-text-with-pre-written-filters">Filtering Text with Pre-Written Filters<a class="headerlink" href="#filtering-text-with-pre-written-filters" title="Permanent link">¶</a></h2> |
||||
<p>Pandoc has multiple command line options that |
||||
apply some useful pre-written filters.</p> |
||||
<p>For a list, just run <code>pandoc --help</code>.</p> |
||||
<p>Here we cover the most useful filters, and how to use them. |
||||
Here are a few example filters:</p> |
||||
<div class="codehilite"><pre><span></span>$ pandoc --help |
||||
pandoc [OPTIONS] [FILES] |
||||
--strip-empty-paragraphs |
||||
--extract-media=PATH |
||||
--eol=crlf|lf|native |
||||
--wrap=auto|none|preserve |
||||
--columns=NUMBER |
||||
--strip-comments |
||||
--toc, --table-of-contents |
||||
--toc-depth=NUMBER |
||||
--no-highlight |
||||
--highlight-style=STYLE|FILE |
||||
--syntax-definition=FILE |
||||
--reference-links |
||||
--reference-location=block|section|document |
||||
--default-image-extension=extension |
||||
--email-obfuscation=none|javascript|references |
||||
</pre></div> |
||||
|
||||
|
||||
<h3 id="extracting-media">Extracting Media<a class="headerlink" href="#extracting-media" title="Permanent link">¶</a></h3> |
||||
<p>A useful filter is the extract media filter. |
||||
This filter is applied by adding a command line |
||||
flag to the pandoc call:</p> |
||||
<div class="codehilite"><pre><span></span>$ pandoc --extract-media=doc1_media doc1.docx |
||||
</pre></div> |
||||
|
||||
|
||||
<p>This creates a folder next to <code>doc1.docx</code> |
||||
with the following structure:</p> |
||||
<div class="codehilite"><pre><span></span>$ ls -R |
||||
doc1.docx |
||||
doc1_media |
||||
|
||||
./doc1_media: |
||||
media |
||||
|
||||
./doc1_media/media: |
||||
embedded_image.png |
||||
</pre></div> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article> |
||||
</div> |
||||
</div> |
||||
</main> |
||||
|
||||
|
||||
<footer class="md-footer"> |
||||
|
||||
<div class="md-footer-nav"> |
||||
<nav class="md-footer-nav__inner md-grid"> |
||||
|
||||
<a href="../converting/" title="Converting Text" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev"> |
||||
<div class="md-flex__cell md-flex__cell--shrink"> |
||||
<i class="md-icon md-icon--arrow-back md-footer-nav__button"></i> |
||||
</div> |
||||
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> |
||||
<span class="md-flex__ellipsis"> |
||||
<span class="md-footer-nav__direction"> |
||||
Previous |
||||
</span> |
||||
Converting Text |
||||
</span> |
||||
</div> |
||||
</a> |
||||
|
||||
|
||||
<a href="../filtering_custom/" title="Filtering with Custom Filters" 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> |
||||
Filtering with Custom Filters |
||||
</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 <a href="https://charlesreid1.com">Charles Reid</a>, released under the <a href="https://opensource.org/licenses/MIT">MIT 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> |
||||
@ -0,0 +1,509 @@
@@ -0,0 +1,509 @@
|
||||
|
||||
|
||||
|
||||
|
||||
<!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/how-do-i-pandoc/"> |
||||
|
||||
|
||||
|
||||
<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>how do I pandoc?</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="#3f51b5"> |
||||
|
||||
|
||||
|
||||
<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=Bitter:300,400,400i,700|PT+Mono"> |
||||
<style>body,input{font-family:"Bitter","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"PT 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="indigo" data-md-color-accent="indigo"> |
||||
|
||||
<svg class="md-svg"> |
||||
<defs> |
||||
|
||||
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="416" height="448" |
||||
viewBox="0 0 416 448" id="__github"> |
||||
<path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19-18.125 |
||||
8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19 18.125-8.5 |
||||
18.125 8.5 10.75 19 3.125 20.5zM320 304q0 10-3.125 20.5t-10.75 |
||||
19-18.125 8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19 |
||||
18.125-8.5 18.125 8.5 10.75 19 3.125 20.5zM360 |
||||
304q0-30-17.25-51t-46.75-21q-10.25 0-48.75 5.25-17.75 2.75-39.25 |
||||
2.75t-39.25-2.75q-38-5.25-48.75-5.25-29.5 0-46.75 21t-17.25 51q0 22 8 |
||||
38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0 |
||||
37.25-1.75t35-7.375 30.5-15 20.25-25.75 8-38.375zM416 260q0 51.75-15.25 |
||||
82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5-41.75 |
||||
1.125q-19.5 0-35.5-0.75t-36.875-3.125-38.125-7.5-34.25-12.875-30.25-20.25-21.5-28.75q-15.5-30.75-15.5-82.75 |
||||
0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25 |
||||
30.875q36.75-8.75 77.25-8.75 37 0 70 8 26.25-20.5 |
||||
46.75-30.25t47.25-9.75q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34 |
||||
99.5z" /> |
||||
</svg> |
||||
|
||||
</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="#how-do-i-pandoc" 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/how-do-i-pandoc" title="how do I pandoc?" class="md-header-nav__button md-logo"> |
||||
|
||||
<i class="md-icon">help</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"> |
||||
how do I pandoc? |
||||
</span> |
||||
<span class="md-header-nav__topic"> |
||||
Index |
||||
</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://github.com/charlesreid1/how-do-i-pandoc" title="Go to repository" class="md-source" data-md-source="github"> |
||||
|
||||
<div class="md-source__icon"> |
||||
<svg viewBox="0 0 24 24" width="24" height="24"> |
||||
<use xlink:href="#__github" width="24" height="24"></use> |
||||
</svg> |
||||
</div> |
||||
|
||||
<div class="md-source__repository"> |
||||
charlesreid1/how-do-i-pandoc |
||||
</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/how-do-i-pandoc" title="how do I pandoc?" class="md-nav__button md-logo"> |
||||
|
||||
<i class="md-icon">help</i> |
||||
|
||||
</a> |
||||
how do I pandoc? |
||||
</label> |
||||
|
||||
<div class="md-nav__source"> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a href="https://github.com/charlesreid1/how-do-i-pandoc" title="Go to repository" class="md-source" data-md-source="github"> |
||||
|
||||
<div class="md-source__icon"> |
||||
<svg viewBox="0 0 24 24" width="24" height="24"> |
||||
<use xlink:href="#__github" width="24" height="24"></use> |
||||
</svg> |
||||
</div> |
||||
|
||||
<div class="md-source__repository"> |
||||
charlesreid1/how-do-i-pandoc |
||||
</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"> |
||||
|
||||
|
||||
|
||||
|
||||
<label class="md-nav__link md-nav__link--active" for="__toc"> |
||||
Index |
||||
</label> |
||||
|
||||
<a href="." title="Index" class="md-nav__link md-nav__link--active"> |
||||
Index |
||||
</a> |
||||
|
||||
|
||||
<nav class="md-nav md-nav--secondary"> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<label class="md-nav__title" for="__toc">Table of contents</label> |
||||
<ul class="md-nav__list" data-md-scrollfix> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#installing" title="Installing" class="md-nav__link"> |
||||
Installing |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#quickstart" title="Quickstart" class="md-nav__link"> |
||||
Quickstart |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#common-operations" title="Common Operations" class="md-nav__link"> |
||||
Common Operations |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</ul> |
||||
|
||||
</nav> |
||||
|
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="converting/" title="Converting Text" class="md-nav__link"> |
||||
Converting Text |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="filtering_pre/" title="Filtering with Pre-Written Filters" class="md-nav__link"> |
||||
Filtering with Pre-Written Filters |
||||
</a> |
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="filtering_custom/" title="Filtering with Custom Filters" class="md-nav__link"> |
||||
Filtering with Custom Filters |
||||
</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"> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<label class="md-nav__title" for="__toc">Table of contents</label> |
||||
<ul class="md-nav__list" data-md-scrollfix> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#installing" title="Installing" class="md-nav__link"> |
||||
Installing |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#quickstart" title="Quickstart" class="md-nav__link"> |
||||
Quickstart |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
<li class="md-nav__item"> |
||||
<a href="#common-operations" title="Common Operations" class="md-nav__link"> |
||||
Common Operations |
||||
</a> |
||||
|
||||
</li> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</ul> |
||||
|
||||
</nav> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
|
||||
|
||||
<div class="md-content"> |
||||
<article class="md-content__inner md-typeset"> |
||||
|
||||
|
||||
|
||||
<h1 id="how-do-i-pandoc">How Do I Pandoc?<a class="headerlink" href="#how-do-i-pandoc" title="Permanent link">¶</a></h1> |
||||
<p>A simple explanation of how to use pandoc, the C-3PO of documents.</p> |
||||
<p>Pandoc is a command line tool written in Haskell. It knows many different |
||||
dialects of document, so it is capable of extracting the content of |
||||
documents in one format and converting them into another format.</p> |
||||
<p>Some examples: markdown, github-flavored markdown, reStructured text, |
||||
HTML, docx, OpenOffice.Org document format, etc.</p> |
||||
<p>It is also possible to write filters for pandoc to process text |
||||
in customized ways (e.g., extract all links in a document, or |
||||
create a table of contents, or turn bold text into strikethrough |
||||
text).</p> |
||||
<h2 id="installing">Installing<a class="headerlink" href="#installing" title="Permanent link">¶</a></h2> |
||||
<p>Available through most package managers. See <a href="http://www.pandoc.org/installing.html">installing pandoc</a> |
||||
page in the pandoc documentation.</p> |
||||
<div class="codehilite"><pre><span></span>$ brew install pandoc |
||||
|
||||
$ apt-get install pandoc |
||||
</pre></div> |
||||
|
||||
|
||||
<h2 id="quickstart">Quickstart<a class="headerlink" href="#quickstart" title="Permanent link">¶</a></h2> |
||||
<p>There is a nice <a href="http://pandoc.org/getting-started.html">getting started guide</a> |
||||
in the pandoc documentation for those unfamiliar with command-line tools.</p> |
||||
<p>There is also a <a href="http://pandoc.org/MANUAL.html">user's guide</a> that shows |
||||
basic usage of pandoc as a command line tool.</p> |
||||
<h2 id="common-operations">Common Operations<a class="headerlink" href="#common-operations" title="Permanent link">¶</a></h2> |
||||
<p>There are a few common operations with pandoc:</p> |
||||
<ul> |
||||
<li><a href="converting/">Converting text</a> from one format to another (basic)</li> |
||||
<li><a href="filtering_pre/">Filtering text with pre-written filters</a> (intermediate)</li> |
||||
<li><a href="filtering_custom/">Filtering text with custom filters</a> (advanced)</li> |
||||
<li>Some combination of above</li> |
||||
</ul> |
||||
<p>There are two ways to use pandoc, covered in each section:</p> |
||||
<ul> |
||||
<li>Pandoc command line tool - <code>pandoc</code> command</li> |
||||
<li>Pypandoc API wrapper - <a href="https://github.com/bebraw/pypandoc"><code>pypandoc</code></a> library</li> |
||||
</ul> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article> |
||||
</div> |
||||
</div> |
||||
</main> |
||||
|
||||
|
||||
<footer class="md-footer"> |
||||
|
||||
<div class="md-footer-nav"> |
||||
<nav class="md-footer-nav__inner md-grid"> |
||||
|
||||
|
||||
<a href="converting/" title="Converting Text" 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> |
||||
Converting Text |
||||
</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 <a href="https://charlesreid1.com">Charles Reid</a>, released under the <a href="https://opensource.org/licenses/MIT">MIT 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,39 +0,0 @@
@@ -1,39 +0,0 @@
|
||||
site_name: how do I pandoc? |
||||
site_url: https://pages.charlesreid1.com/how-do-i-pandoc |
||||
repo_name: charlesreid1/how-do-i-pandoc |
||||
repo_url: https://github.com/charlesreid1/how-do-i-pandoc |
||||
edit_uri: "" |
||||
|
||||
copyright: 'Copyright © 2018 <a href="https://charlesreid1.com">Charles Reid</a>, released under the <a href="https://opensource.org/licenses/MIT">MIT license</a>' |
||||
|
||||
docs_dir: docs |
||||
site_dir: site |
||||
extra_css: |
||||
- css/custom.css |
||||
theme: |
||||
name: null |
||||
custom_dir: 'mkdocs-material/material' |
||||
palette: |
||||
primary: 'indigo' |
||||
accent: 'indigo' |
||||
logo: |
||||
icon: 'help' |
||||
font: |
||||
text: 'Bitter' |
||||
code: 'PT Mono' |
||||
nav: |
||||
- "Index" : "index.md" |
||||
- "Converting Text" : "converting.md" |
||||
- "Filtering with Pre-Written Filters" : "filtering_pre.md" |
||||
- "Filtering with Custom Filters" : "filtering_custom.md" |
||||
|
||||
# Extensions |
||||
markdown_extensions: |
||||
- admonition |
||||
- codehilite: |
||||
guess_lang: false |
||||
- toc: |
||||
permalink: true |
||||
|
||||
|
||||
strict: true |
||||
@ -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,23 @@
@@ -0,0 +1,23 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?> |
||||
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"> |
||||
<url> |
||||
<loc>https://pages.charlesreid1.com/how-do-i-pandoc/</loc> |
||||
<lastmod>2018-08-11</lastmod> |
||||
<changefreq>daily</changefreq> |
||||
</url> |
||||
<url> |
||||
<loc>https://pages.charlesreid1.com/how-do-i-pandoc/converting/</loc> |
||||
<lastmod>2018-08-11</lastmod> |
||||
<changefreq>daily</changefreq> |
||||
</url> |
||||
<url> |
||||
<loc>https://pages.charlesreid1.com/how-do-i-pandoc/filtering_pre/</loc> |
||||
<lastmod>2018-08-11</lastmod> |
||||
<changefreq>daily</changefreq> |
||||
</url> |
||||
<url> |
||||
<loc>https://pages.charlesreid1.com/how-do-i-pandoc/filtering_custom/</loc> |
||||
<lastmod>2018-08-11</lastmod> |
||||
<changefreq>daily</changefreq> |
||||
</url> |
||||
</urlset> |
||||
Binary file not shown.
Loading…
Reference in new issue