From 7f1a078520017c6be259b0aa03ed341c2c86e9ee Mon Sep 17 00:00:00 2001 From: Tom Johnson Date: Wed, 13 May 2015 07:06:24 -0700 Subject: [PATCH] Added instructions for shortcuts, iterm profiles, collections, page frontmatter, and other documentation. --- _data/sidebar.yml | 25 +++- _includes/custom/toc_id_note.html | 1 + files/atext_shortcuts.atext | Bin 0 -> 10331 bytes files/shortcuts.zip | Bin 0 -> 7489 bytes pages/content_types/collections.md | 30 +++++ pages/content_types/pages.md | 114 ++++++++++++++++++ pages/formatting/pages.md | 84 ------------- pages/formatting/shortcuts.md | 16 +++ .../{publishing => overview}/config_setup.md | 2 +- pages/publishing/setting_up_iterm_profiles.md | 35 ++++++ pages/special-layouts/kb_layout.md | 1 + pages/special-layouts/scroll.html | 1 + pages/special-layouts/shuffle.html | 1 + 13 files changed, 223 insertions(+), 87 deletions(-) create mode 100644 _includes/custom/toc_id_note.html create mode 100644 files/atext_shortcuts.atext create mode 100644 files/shortcuts.zip create mode 100644 pages/content_types/collections.md create mode 100644 pages/content_types/pages.md delete mode 100644 pages/formatting/pages.md create mode 100644 pages/formatting/shortcuts.md rename pages/{publishing => overview}/config_setup.md (92%) create mode 100644 pages/publishing/setting_up_iterm_profiles.md diff --git a/_data/sidebar.yml b/_data/sidebar.yml index b5e1cf1..92adc64 100644 --- a/_data/sidebar.yml +++ b/_data/sidebar.yml @@ -40,8 +40,7 @@ entries: url: /troubleshooting/ audience: writer, designer print: true - - - title: Formatting + - title: Content types audience: writer, designer print: true @@ -51,6 +50,18 @@ entries: audience: writer, designer print: true + - title: Collections + url: /collections/ + audience: writer, designer + print: true + + - title: Formatting + audience: writer, designer + print: true + + items: + + - title: Alerts url: /alerts/ audience: writer, designer @@ -101,6 +112,11 @@ entries: audience: writer, designer print: true + - title: Shortcuts for Jekyll syntax + url: /shortcuts_for_jekyll_syntax/ + audience: writer, designer + print: true + - title: Single Sourcing audience: writer, designer print: true @@ -141,6 +157,11 @@ entries: audience: writer, designer print: true + - title: Setting up iTerm profiles + url: /iterm_profiles/ + audience: writer, designer + print: true + - title: Navigation audience: writer print: true diff --git a/_includes/custom/toc_id_note.html b/_includes/custom/toc_id_note.html new file mode 100644 index 0000000..985df75 --- /dev/null +++ b/_includes/custom/toc_id_note.html @@ -0,0 +1 @@ +Make sure you leave the `with_toc_data` option included. This auto-creates an ID for each Markdown-formatted heading, which then gets injected into the mini-TOC. Without this auto-creation of IDs, the mini-TOC won't include the heading. If you ever use HTML formatting for headings, you need to manually add an ID attribute to the heading in order for the heading to appear in the mini-TOC. \ No newline at end of file diff --git a/files/atext_shortcuts.atext b/files/atext_shortcuts.atext new file mode 100644 index 0000000000000000000000000000000000000000..81c8b886b6fa67d69377706f7e8c84e6f0f2b78e GIT binary patch literal 10331 zcma)C349aP*1t28G;P|XNt%^rnbso0V<6jPVUw&1LP6U?*-6_eO-YlIg~ftgR1jC( z@gX4M^1uaU5s^(qMfBq#Ac$-tAo3JN@%cnV^gEMG!1w#U@?QJ9H`y{7mHNl+m&pf0E!8IcK@kptQXa>3+b)Y-Y9CSCDi{_(8 z(PQXwv=A*qOVCoZ0h2C)N_{iMNQ2#Cyd1#17&^Vi)l-v4=QJ93hSp$BC1~Y2qv52jV>OBk?cd z7vd7}8(Ba~$U?H1l#@zQMH)#HX(lVkDzY1S18FB6q?2@$eaQag0P<#X5IL9}N)9J$ z$XaqdIf0x=Hj>R`lx!u_WQLqd&LC%!vq?B!GDxNfk|A_xN zW<<`>>gomsM+(=q{G0lkc(lEpOQ*&JBWW&>SdgMr<3vc z++oJ%@;F&**zUH6thc$WaHq@ZuzG^N5EJrvY>d+xa4^20)60atVNcK#@;e-U@4hUb zN>ueMx(*lPAC95xQ8#o0>JHA_1DKYhzo4FoLA_9KWJNakw<8DiPQ+&4xsVHaCMZg8 z<5FBYoJh7s(&=b?5=a7(6j#H=Q_*yEYBW7#OlW$0B;Mp}PQwhUjB)O^42!D5KTun=2 z+MxJQE}rp6l68a9TwAJ8fp967;q$nps0b@S4ahy0^+=8XgT`rIX#8c|)t z+h;j^9;mOb8J3L}BZFLXBoj;Lv>QfMuPJDB6S^40=%?2Wi8OGru|p!MbSAw4Tb!&M*1>=egJAWlvwZ?@S?<$AD-WjN6tant~N4fs!a~Rd!Bb84y?wUwR&( zzkptZ{%-)jE3`@=P=T+**W)T65b)dWp>W8@cx=`H;|#jojK|>!GNGWy8FsLapxf!G zZ*5GpwSgPtIJ}(0yLiD(;Z1qGt9aQaLR-^+^2)qybyh}xG4-9AEm%H5VeaTk3j@(z zXVLJEi#J^rbk1cxaM=J{HUf)HXfyO%fJaYg-GR#uxCdtNU-&rSV(oSZxSZSPcQQ_! z4Y&Xa#v2X?JPyCj>hZfqwMH^cQ7+yn7~~y+%*pwEZ_ERKFDF}izhul6BYhyq6ay9$>N;?SuXk;NpO01wOs8 z4Lh+N_&BU~kHh5(GOXVY^T^3M8J|7qU_x%I+vyBB!|s58L~C;r=4j3`2Xi2o6gPR6 z<;fh*$}ZlyZG7^#yzCe++eFPj@^nbYlSwfQBTYxsF|H3yOWQe!^08=qav!>PZ)rL* zDbA#cFu3k7YA!|o4( zxxF@6D6JmG<#)Tn&amC%b-8kS`Bu=2@$ibnc^!QJ|Hyv4Dm#niog@4iQ2hc3e+6up z&~MOR223|X>jwz?;{JFb9smgK!JyaYv)dV~-{oMO9*7QJmkkzZyTj)TguR}S%Te1J zZJU&ZNf5%%SA6}pSb#~0c-bb@LjF?GJuj1FW#ppcJ?4JPn=jlChM-f)#{QKZ9du>y zXj=qU(%#L{7}u*kKBWFwS>3i>kO8ip1CzJ46UH{lTQ4ThXvryatdC(POzC&Un#dqI|Qxx-;# z8}>qs8QGfV*L-`9vQD7Pyfk}Fo?aJ0w(CN-vb@ZcmHoQ$FFl|6fT!$lOvGp!h(Sb& zWt|QDjhV@J**|GAF^&J2f5~3|=~57PPPY>1Rsr4XfoM142I#v3)uGS^1KmOR7F>;o z0NnuVbNIZr0OJX`!Mx6ZmGRo05K37O%v!gb4FyA^!MyE>WI7_uQGyZJ-FVMW)AH=B zIoZ-`BCT)`x678=N+^b+O5E1 zIKB|vYL@9{W7j=ENU{^m>;5P%JRgL^g) zHY^aBxbWN~dD$RdwuxMHRyY4CoGN5yw)xdK& z@VpHe))2MO*8#^d(CUHbNIVLU#iM!W47x*hU)aV3-7L#MRtQTq>kTu0r^5^Bvdiu9 z`s!NakOJj+juLp*|MEIS{G4p8z>_;ie4m$1$njk5llYJEJQW=s{2*YX|7fBnfZhzy zTL5&FXoY?(_5Wr8rG}d08e0eqEO>PhR4|bN@E4I-g&{O#AaR`}1rQu5&N{ z_omK`c{^xiCTQdi(8X*5Lq7+!5rx(a8sYFH+=^Rxr*(Q=cAv+~SnVvNEq(`|cLhR_ zcLh9N*6;I%0^wT7yV`T=m@81?s9IKcz=yS;9gE5NuzR#?-6R@kdpSr_9E zTK!(T*B!9gto5zaBFQ-HvU1>ax#0OFhiu(n%7b4jfS<-3smsfr&4I`LTxZ_r!IyP( z2;=-W1YQIJD}caD0R3g+73g0D@YA5Bfj|mp@N_&C2sj)zFQkkt19Jul_-!@_7ydA~ zW+-4~eV$O*$&PAmY)`@}l$?=ckj(@)o?m{$uT(z4C)VW{EWhbO)2cj!H?y+K4~}M6 zEan-QJ31O8u~;ILo*<0JM?R_aKTfR8KxQkD*#^IV$&LoAfkV^!AV#}oZ-Fe&}WpV$+ zR*8AsInI9gP6!?m`>oubJK47#T7<~#{4icY1e+byjg?1+} znuG7c^YGp9D}F!g^|2mUj%xtM`R?ZIy%hbK~T! z-=D5br8CXVmEZ@Rhr{1dJBd)5B$17zND=g6;P4oq#D3#0jwTi8ptltmjlp6&=vyNC-GDGY5Z3J8+LfT4o?skvS5%8 zfvlJDyWFsQc0$nxs$8t!6{=~CHs`=vvLG%l*mj}Upgge3oNV!$Mf2{;%ewNiO_cc4 zeQsEqCn!w(=A${6@3zMx>1L>1(fvW~)32#=vInr}2`qX6{@$b&dK)l!7TQu^u>?PZ zm*Zu?g0)(M4!hUNgl&*XI3a~%{17r259~Cq(>lf zVEdpi^F;azM82#WJ{8Ny0FCS**YXo`Ab|D*=peuikzwd>0>CSvy#Sz}$1mcQ_-_E( z37bf-)gNRadjNlT`(3cx2haD1{VrR`Z?^_QEP#%s@}O@KK%csObx9szwIKU3S>2JB z-Fo#tqX3#83V2u0qq*R4!?=t0JMJA<?On$d?aafwU69?_z1WtQ&C1Fy??3bX`)=OF`GQJ*f1Rs7 zAr~o;ckMpQn1!H5?RaGBlj+WN0XH3O|wJ+F<`d$1;uSOe*_1 zorXry05>*f z+ES4?%}wt~N9bszF#{-sZ#P3-1&V0EFw%=2o{T_6J)XY869DHwhTptOteMM9f@*kA zIv#Ck0dvz(c1}hcIT)2M#Y5pK%TypXm5Xz6sGSSH*)yw`sa#7GfJC4O)4(MY@Wm|b z2n3dBTTVp~Ase|QFn|g?umIXw%}j;2(S}S6Fhl7b_OZR_TQkwrlnh5_(md}bsBC5_ zwZY<+rIi4PS5ffl11)Bf@dy;ik||JPLkx}yc+-uDPK~sIAa7~91@xZel3@6(x_fo* zz)yh#F9HW%46eI`Tnha&;Joiadj}kN8{UrJ$M1pzJHj5X*Xi*vemleuCmf0}{(zfh z+%^Z~NH(X(#bQ-d2 ztCevFLqVU%2@%j{AIYyOS1`Yo$M?|C)p>lI1=;hLe%O_ly)9rqb4PeEmXFOXEB^`h zdjNX}z}^XfKO{ebo`<{-+Q$HUH{OFk!FvI=*B-Xp`BH1x8i1_R8g%EDbiXeEn}VPf zau8>Idos}k6HZ7%KF;DH7tbdiapf`Y6J$@|K_l|A16S|6i4S_pj*e^%D?i#bN+9H6 zfPWO=e-6NplV3o80-*DW^QQp+06vHh|BCjhu^^jAzy+#1Wwan%WY*stk-LI zSYc~sb=3<8#sd7)SDQ_yj%<@NI6VJrsiSz1_=aRh|Hp8Cg5agneGSFX&-en=d#z$u&mX zxe2khT&yv#lAn$=O|HR{vMWy9NcS0JT$v zC{0O`jVh)}pqBysGtj;S3a9XC{15yUPzVNLsjcKM8RpnLmu6lmg@xY+z3wvRaU>HP87yFUuAhfd<@nf~TPq-00uOycQKBP%#4) z8c0-7mC#=YG|oXg3skKizUw{TSNpl8_4Eno{j$B+2jYEH7k4W zMcF9(`0ARWnQZ0NmrO=xJO?rd3cz7#_HFJqmU4|1j>m3FCNk~IDK`rIna9||aKsLc611<2#K#ZIQ4-9mWv*3||IpkgN zxWGbkF+3))8Xg2VLXqHXayal;Q8!VesL9kcY9{pv^$fL=+D7fB_EQI_gVZ7F2z87) zPJKb0piYUTqB2prs7iFbsJEz(C?Fav8YZe2O%z2%uZUKOUKgzqtrM*mZ4hk~Z5C}6 zZ4+%5y(iis+9~=-v`e&Gv`4g0v|se8=rhq_(NWRoqAx@zMPG`(68%H;jp$p^IdQqT zLflL25Dyd&5!Z?%;zltio+OTnCyU#}3GozhO1wzCOuSOOM!ZhEMZ812Q@mGvSbVgg zs6bWFrNB}!q@cQBc)@K2wFM&z>I+5}j4c>nFt_0Tg2xM%6g*R~qF{Bw+Jemm?-zVf z@P$MsDU~QCWfF}MC9g;hNsdU4NsdcS zNKQ#kOU_8XmYgkA6&ee>7WOK%7J3W)g~7t1g(C{<3uhLtEPT1})xy^bR~N1=e53Hq z!nX=H6`m~oy70%sONEz<3W`dLlto>Nt}E(V^mNhAqK}Gp740tCQ?##Wf6=E!pA{XJ z5>lzOOsbKZrQM|6rFLmwX@6;}G$xHp+oefqS~^uaU3$B8rt~@K3h8R;M(Jkh`_kRg zJ<>zclhQAXnc~sKV~fWZPb_XIZYpjrZYgdpjuk&v{B-g2#jh5>R=lD3o#Jmb_82wd8}64@*wU zN@Yq}nM@*X8d8|9njTjks2+vV@c z&&vNP|E*M9Dk)Wz8cNGct4f*D-lYpm-z(iwy0i47(p{yyOZSxSE8SoEY3XGJsVG*c z6Pmm1~rnlv|Xa ztBO@JRjEp;DpP4xI+a0Ht}>~Ds-db8stKxys#TRzWmI>l?or*VdR=u)bzF5qbxL(w zbw>5I>a6NJ)%RuEGILqCGHaQ=tZ!McEL=9MtiEh?+2`tFwM<>AR;tU?8nsSsP?xJs z>Y#dvx=uY_Jy9K1C)H{7EcHC~eD#a!Pt*t02i1qvN7TpE$JHm)r_`r4B^rgspsCbU zX&8-5SSQgH>56qSom1CW7t{^a4b#=@BDzLhOqbD3)7_VKgkGvI(`)o*eK&n~y-hz}KT+SHZ_+pGTlB5^m_Dv=*DusB z)34O8(XZ2Q(eKdj)bG_F)*sbhHuNy`H1sl94R(Xm;4*j&eGL5!jfSWpY3MM_GR!k9 zFg#*dWO&Z-LiyJ6v*q8Fe_wvS{Ga9jD!)*EvHVi`Wn-1GyU}j!YwT|f8;2QhHI6nm z8aZRaxY)SVxXifR_`LB&;|k+T##fB1j0cRzj9(eQH=Z~CYNAYHliZ{;8BEukYD{&e zk)~0mF{W{*38sjt(Zrb^Fg;;fYWkaLrD=_6lWB`-hv{R}Uejr_%B(hP&3bbev(aoe z)8&MwkojTr^X9$gPs|6*2hE4fN6g2}$IU0qrz}#7 z#$vW~vvjxEEqyKhEn&+r%dM74md7nmTAs2jvMjbNwJftNw>)oo(eii8QOjw|Im-{0 zi!@1#Xc?`g^|YOy02{7GnxiMtQF=1nMknYg^i%Xp^jdl|y_Noe-b3%BkI-MzUsVtl z(h5TbU2#K&tztk$pkjE%sEUS)ri!+TyDILhSXi;LVpYXjl>LLsTlS9%WmFVwwC{(Zk(3VUt`USmI;Dp025E$$8-$@-NkJz z8y{~k{{MXI8{q?f80hNj{>|TLWPl_S++foAh0Yi0LeQ0Bm5&+r*$d3!__mfytm&_0 zIUP+o#ht`TxSVwAYK&46@V4W{r7#rC=$i|8nVA_2nQzaCiESy-Qp-5YCpnn;H?!@5 zlbb<%?fZTj><;XH5073*$*Wuy+Li5E?}0b#F*pj$cyTFIDcAf=n;!7-{qiz7ECQ7NBv) z%9T@(%QSuV^%nmaft2%_4!*z%B$JG$D17CJYZ7lzka76x0xysN{_1#&;sU%9zwv5y zI_8k2fe4|LUnqabDfUiE$+D>aknWcLJ~l)tlsL8^7FZaY^7M_Iydy69YgS$i^$W(Y z9Dz^Uam9Zyul33FXx1piHpew*Q^_SVDn7mJqq3GDVWNqBIjzbX%cT(gK~aqZ$%te{ zG9%fMZ1jxuta+>ta=gr$#G|neaR;&beU*LAeJ0kDXY949{>lFNOB%t-C#+KJzN9g6 zEPdMBFFn#;st2nCD+O!b$=s!1XE!U{sZyjotxMr$-z!ejOI4gv_&AJL7k{E?p|qlc zeZ(qh%TOmR3i}>Mr$ERalh!*-QCLOG9B zGu1N1VW@i8ZP;sfa`zRA5+#DCO~zKZtH)JRFv7`aSJ0}ZuV?tvq(Xc?{inJy7sp=7 z?SejA-PtuqIgX090Jki6F@v%Bth1m9izLlPl!{;>H%)T!>?8|yT9Hn%jH;S7UP28O zr9|>b3XM|=#Ze6g@YI0lOKS@Kk(CWsd?{ z4$g`@i_Z1_K*_{W=%s+h!jbLw5X}#@E$tdv!Y)@!@(ZTx2F)`FZ=-hE&{*7ncJROv z{!6ORsUw@7jvA3ef?7iC@!B zTH{m#3*TJ;LgDK>O;`T_4o+3Ky%{t1T(xhCg4ssaPmO@7LWaF;Gqq|iZ+KtWs5u6j zvQ8hmjdbBvyle0zC99B)Yjm;a%yQBIm&SavgWWW*>3{pORIFn5Mvs%kDb_0~;wdTF z&yTzxW~f8u<>PZ`5>5@v2Iqx1$_P~P_nsPq(<*4+|1g=2!i$8|;)fU(N04&C-fX zAQv$`?ubJZUorh$h;BXH^_6fr#r$UyN7f3ZqA5oqtfW^vQ~p9|>Ix)tu)=Z@k8)g| zTC~|_T4a=YGtuvzoYUtLz~tT}e?g5O)KoidXA##P->IY%Ec+_Yul-Ec7@?ox+=ioN z^&+g7w3a4cBEXrijXU#eG0i7n;#QZ-a2In33x0aSh}xWG>_8UjjpJ$K^0P(;iV%sj zzU=P^!j0b)mt9?$(|JaDdX80i?&cW&9w~`D-A65y1Pgfu4mj1Sm4cMp0f)%co(fY! z2H+?06N{8TueY$f^`A`17cgLbv`_IYSiz*N#ms?Kj2>Tz<}ziT1)SVj`$SQ9j=y#Q zx;D)p`CW(eSHr(X<-3XEC0l+DWYRnyCS1LOggiPSg#%V~v#P~)WA{85KcZE^pDE1N z?67L%*;S29;PRpy6Iuom7Dy*s0PYO|o8-k$arCyFPro(e;b0iGNs1tSV@0%;JH6-JXHKOKSET)dA4H;`N7##zsY*7hACm zPvz(!3Omb+@Ad~F9_mLHQqv-e+1xu(vwrN=<`vvYa%U~^ecOEl``|GG5yR71Z?qxW zlP?p371;@Bgd7@9b)uEh%G{#$bTmuT$6^EIf}S6q|3UZ;jI=&WoPDy~ebCsA1@*hW z538A^^%Q?&Y7I{pbJZm7LGW}0n)1ppD?IxwH@-VbzJ3l?aed7vwqb)53BK;Rx55$o z6#u*0#jT7dXwZbECjGZ-e1D4tG)^VsLamjr|6BK)WBFd+@yjDfTq~1?dPsOFb*=H+9p~xn_>=A`XVb$lrHd^F^ zhe_TieP#Z61>1m){btYg;Jn(#_Is3az5TRzka(Y$!GUr5Y4`;i#XTT2)EeLz621_= z2IP(2G4*)%6^(*kX=tymzD7wrm$(78Ie7irNdT={(xtx6qMBv5-1*0%8=;X50DR$t z%$8WHk+ItD@gh2aMnoD18i+iqBluE3OH=9VxVeMJDvhszo_Fs5?Q zyb~SKB&n@LU}}KFoihcxev%G0_nT!Hx*QpyES^W5tjLaEmqG+z*OB`&({f9DPpjvy z3>)U@tef-_h)9TS3H+TtP{M6=zpMJV?j{Z*;g8fjt~kFGKHtn*4mGlFX$o!fMy9UH z*oP~*Vq1=}KR*=RN}^IG^^fdLcYor#&jFu3X#CSIHSoqycDYCFx|N4Gyp?C`vc;$q zM252{w?3a)Bzonk8V4QI%?I^)qDDvg%kutsB0o%D^tSn(BRQdNF#-=+T2dG&96%^O zqqK$uS|Ah572OGQ%Okf-*F6n;A~2Y~NxaKn&R}Ua!r)N9ieID`3tlyeJjZYWJHH)m zQ07K6Hz1tT1zyWHB0>9M{N!DlHt**4pp&~@J0Zvyzs|QtS5~7u9w>nzSQP*W0$yar zX32H}x5~n7VKOuhXWkMSAXPdr!}~;jtOa~xD=1i*(uJzjp3}l zhh2cnK-)%Ol3y&eU=x$MDWU;Ad-YUJf_8FyxEb#9atmL8P)SJxMze7oVX+GJ>-F6` zGl6Q*>UE|zs)5;xqs*ADiz?MBHZunAQ>`kWo;Q0ncAB>!Urv_9SBH3^PX|W?lwfqY zbf^-jonS6wCrV-RW5-4m5TWI?F!}+CM6Wd@h&D0(UK?jk{zCQm+SL;MG0gTk;0gsN1ro_LAGYE{{X#K)N(O`#Vy| za_ofF$vchXt83>7;e%gFb+_pzEWd+oB20=Xua#k!{&XQY7!(57#NI%)O2|5Q{jf4) z;_=4UC}(-gB<(-?6SuX%87E-vA(b!HTMW#Vdfp?AF^T{1Z8`gDOfwuhmbltEzRGXW z!rvEENoW0umV@&C!P`zO9r~u?`Pq0Nx}+a)3V=Ay1{F9)VW9g!z*{ z2znGL@KIb-dp1T**sTs_prMsD3(8}{`G&rao{YRL4|d%PPuj8e!u0oD5*B$s`Z;VY z2rtgYO0OS_PKvMfi7=?QgctJB4-2vB!o5S?|6EkI=ANLe`X1LA)C*$MLi8171!)zBNmV&_^1=v#YsA!8Z&?5qXebF-2w^A8aJv)e z$RU&}#Y1ab5D2?LzFwa~^o}|7R;^N4BNk+aFbj5$Bo1>hr^;MS&C{@r_?AMH^_vc$ zO=c|IX zI1Cz%+iOd7)9VYSL(Mg?(s(H|-?Y?TcijhgCxs&p)0Q8;L({B+ei3oKuVQ&z&6FFE zeF~$v)%L{827baSK9*eot_b@-3qkLk0KLk}L3~*EB@znJVCW=kcg?JAGk4*{$tWGA zD0d@S*`|B%)Ut1Hx+w5U9ChkS>LTI|YTSd?ds6#vW}p8GLJ{eq?tPF)@?Q@~O-?3S z*3djD-LtWIk?aQ%9oYV-MEYQ0mdKf@|C5crG9~AwU#Mou#C!(;TsGzGPl0dPSB|Y( zSu-<22Xl$+Z4)m5!w{NUu)ti0B+>2XT!ie7p&P^GD*gEKyBBTE$FSJ6Is6~kpKYK= zE$0;eDRT~xs{s+xP--eT0r zgN3zfjRKhkIa|T4l;*v{GiI6ZiVKa!2nJhBi(3p1r4RkVABRiDCuXS~;b~mga^UeM z=34KMMK(#^xe(L=8jcxNGC+-AUNfoK+L$WXku@j2#0!9i33#Vi4?j{4-!Hw26tGEk zq|n0IbPazO1F_xuooaD$suu}4C+a{+Jnjjto#WNA^NVv)poy?r6O0qPiqTFMTWb?4 z?lJV21?_*p>nrud2$#$ z=ez*97>ClHK_huEA&bMyjz1@_Hq(+y%4|i&a()De3}B4GYg&A!RDpdwoc>o~l=WW} zFiIV{32eZ9ET_Ua>#<97$~;v3K?T%zdD}Xtwdlds6C9`Mj0sjiQ1q9!NHe@!rw`wM zg?&dS_2=1$-W>dex-?%pJ{N7bi2fFH4IiMjUV;tw`@0a9r@ClVkMC7LRbG|u?eEpM z#PCgH=X*Zn=2wDn8vBXpI8cola`6wHt0$v1!DPJhRNECiuH-|`0Dl4*bI4cpdokF( zbjmZpHToUXMx6AvANhja)$&?OW_wkZhny(E{I~fL|M1TRo5zv(j`hjAei@@5Hpg~? z+z)?Bbf||TS|FQ%su`;8foSbro_5P%?Tz(dL%ju24*XlM`+M7fb9 z-5msIoTP7Dy-|X{b_P^vI8UXo&KQRRK86>Nzae&bYs$Th^F)JFPHMu3C*gpUsO_BU z3a@eStbin7^?_$`eTYNSE-1)VlTxwGWI_txlWZ##t1CG@KSBy^>Za#L7uLzZ&=qqg z`=DaoMT0MHgiRV5i2IWmbRopwnSt99EY;SF2hW~22i;lmc1gdb{y7j4P##L@qS^WO z2Wr9V_lOVWBY8+jLuL0P;Vw4pkp=L`aYK6e1aR+_Vgq>Oe8A7|8bs?D-)V@ETL9Qx zo#|(Y5ZedywAH`FRKuP-B{dO7S;3EOX0rp|fiK^vuQp6j@I z(a1@mNP%j_ejIBoZlRR&0&ZDLbfJl`Tug4u9kd!N6& zi~UKsa>oxeqPRTx_YYv)x8d!B9=G6*agC^!m93BZ;NY4a|A?f)b->Ahp5SU@E~=m_ zpSPv$Ph^{$>GT!k$D(cp!#uU zCfE;B{L-EbMeSOn0z8ESQY7S3pD*ve57*Ha(J3k)o)db*e);@T=v&%~Dx&bW_Mb24 zb4)*Rd=kYp-fDa*(1m}4_{0l6s8w~6fEN(_-{=v zk`8m5&CHmPY`(GB@iDQ^{UjcGV{sgDHrvD71|B*RuW~6sPeG*BWYr|qq;3>$l)s37 zkuXp&@Nsf$k$ZF1kl}Nc^HW*4JIg}5W5aL5r!j4w3{Z~oHCJ!dhO=R6QdV&qnb$O0 z>309YWFQOXPgPN6Q&q`UV3}6IPxFjZu}+O->t(%6i)H1GgVd!tJ>_jt^33108)h0N z85S7!7{(pu8g?3{9yUy?kE)QfdA-Mm97M>+n@Hcm# zA1ghJPc}J&>rdf5=~0&C4_f|TPMZqD3ul<^w6hAG<69{t^&5%~iwZxzYK!-!MDVQ` zUN}v67xwDNac5+z26puNRIo~?x zI_q1@R!FO9pmLzj?JEIYiB^A?v+M1+euDm_e)azGe!l**ZKZ^K?vSt78QX>lB4nMq zcdlm>+xPw0s)=k7s;>OhCW2MFnQ0%>TGLY5ic|;QuW6%XhDq5pvm|s;*261li;%|m z!CI)-!z#vK)VO%koovOjWexaW4D;6EEvwhPSyom@;utBeqn z+njJcGM+g+cu!%o#}WFXNlY#mR!m z@;TpeYw%2PcIcYvndxw6pub1Ys1hv4=W){^G$7PA;ECZW<2vB{r7u+xY}TT8W4Ncf zN3&--GCne?*Uz0@p;w}p@kNOH(?|igVYZ&^yw*ISV5{=y;SR^!C#Nm$OvskM^qvh3;>L$A(#*>U-gN3 zbPKsNxeK|oW>aQ!G!3s2>MPwVOe=2??g;pb2?7V&?%U{_=NtB01;LD{U&;Db+2H2b z^rp$l&k5udI{WaM#rwTRRr+DPcfVNn#FyjBCqJWqMj!q3Au-pZT(t9<_4fN|F$Q_wl+40IYg51oBm^2gvR9Z4klIqT=>1x>s0ruwG2+idcp=A6hO?WOvy{o4eo zubPLe7f&unFL*AUFODyAE>|zbFM=*&E|o4jsROA3X#%OMu-dwv+-bi@OGSr7mowQb zQ?C%z~ zoz$DyM5RPqq&V?Gh#$-^%>RO4M9Lw!ySeAO@XT(9dnaT^U?*$feBf77=LgR8C03Cm zHLTfhr8K&qoQj>^J0&{hI)!st$A5e|dtW-J4p9#kh6}+3+U-_cR$OnF8V0>rsst;? zP3kw+`dx%_#v58@% zw>bBh_jZ`tOz`J=Q{;>KOWas`7~Ii@i4~6Jj#ZBE=KAf8_$YE79s~WVSI@vQyG%h4 zF?B5P9TStR7Q6BwJ|l&aZci*RrTWC=JcO5XNM)XfSDjaNjAwWZV#hfr^8ESpI` tags | +| autolink | automatically create links out of URLs | +| tables | allow table syntax | +| with_toc_data | add ID tags to headings automatically | + +{{note}} {% include custom/toc_id_note.html %} {{end}} + +## Related posts + +By default, posts contain related posts beneath them. To disable this, add `related_pages: none` or `related_posts: none` in the frontmatter of the page. + +Pages have tags instead of related posts. (It turns out that creating "Related pages" in Jekyll is much more difficult than related posts.) + +## Automatic mini-TOCs + +By default, a mini-TOC appears at the top of your pages and posts. If you don't want this, you can remove the {% raw %}`{% include toc.html %}` {% endraw %} from the layouts/page.html and layouts/posts.html files. + +If you don't want the TOC to appear for a specific page, add `toc: false` in the frontmatter of the page. + +This frontmatter requires you to use the `##` syntax for headings. If you use `

` elements, then you must add an ID attribute for the h2 element in order to get it to appear in the mini-TOC. + +## Specify a particular page layout + +The configuration file sets the default layout for pages as the page layout. You can create other layouts inside the layouts folder. You can then specify that the page use that particular layout by adding `layout: mylayout.html` in the page's frontmatter. Whatever layout you specify in the frontmatter of a page will override the layout default set in the configuration file. + +## Comments + +Disqus, a commenting system, is integrated into the theme. In the configuration file, specify the Disqus code for the universal code, and Disqus will appear. If you don't add a Disqus value, the Disqus code isn't included. diff --git a/pages/formatting/pages.md b/pages/formatting/pages.md deleted file mode 100644 index 265a7d1..0000000 --- a/pages/formatting/pages.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -title: Pages -permalink: /pages/ -audience: writer, designer -tags: [getting-started, formatting] -keywords: -last_updated: -summary: ---- -{% include linkrefs.html %} - -Use a text editor such as Sublime Text, WebStorm, or Emacs to create pages. Make sure each page has frontmatter at the top like this: - -``` ---- -title: Getting started -permalink: /getting_started/ -tags: newbies ---- -``` - -Frontmatter is always formatted with three hyphens at the top and bottom. Your frontmatter must have a `title` and `permalink` value. The `tags` property is optional but potentially useful for knowledge-base articles. Make all tags single words, with hyphens if needed. Separate them with commas. - -Pages can be either Markdown or HTML format. If you use Markdown, you can also include HTML formatting where needed. But not vice versa -- if you use HTML (as your file extension), you can't insert Markdown content. - -Also, if you use HTML inside a Markdown file, you cannot use Markdown inside of HTML. But you can use HTML inside of Markdown. - -For your Markdown files, note that a space or two indent will set text off as code or blocks, so avoid spacing indents unless intentional. - -## Where to save pages - -Store all your pages inside the pages folder. The number of subfolders inside your pages directory doesn't matter. You won't have to use paths (such as ../) when linking to pages. Instead, all the pages will be pulled out to the root directory, and links are established through the permalink value in the page's frontmatter. - -If you want to use a colon in your page title, you must enclose the title's value in quotation marks. - -## Pages versus posts - -Most of the theme is designed for using pages, but you can also use posts. Posts are intended for blog entries. They have dates in the filenames, and they sort chronologically when get the posts. Create posts inside the _posts folder. - -The latest_posts.html file shows the latest posts. The tagindex.html file sorts posts by tags. The archive.html sorts posts by date. - -{{note}} I haven't done much testing with posts, so you may run into some snags there. {{end}} - -## Github-flavored Markdown - -You can use standard Multimarkdown syntax for tables. You can also use fenced code blocks. The configuration file shows the Markdown processor and extensiosn: - -``` -markdown: redcarpet - -redcarpet: - extensions: ["no_intra_emphasis", "fenced_code_blocks", "autolink", "tables", "with_toc_data"] -``` - -These extensions mean the following: - -- don't italicize words with underscores -- allow three backticks before and after code blocks instead of `
` tags
-- automatically create links out of URLs
-- allow table syntax
-- add ID tags to headings automatically
-
-
-## Related posts
-
-By default, posts contain related posts beneath them. To disable this, add `related_pages: none` or `related_posts: none` in the frontmatter of the page.
-
-Pages have tags instead of related posts. (It turns out that creating "Related pages" in Jekyll is much more difficult than related posts.)
-
-## Automatic mini-TOCs
-
-By default, a mini-TOC appears at the top of your pages and posts. If you don't want this, you can remove the {% raw %}`{% include toc.html %}` {% endraw %} from the layouts/page.html and layouts/posts.html files.
-
-If you don't want the TOC to appear for a specific page, add `toc: false` in the frontmatter of the page.
-
-This frontmatter requires you to use the `##` syntax for headings. If you use `

` elements, then you must add an ID attribute for the h2 element in order to get it to appear in the mini-TOC. - -## Specify a particular page layout - -The configuration file sets the default layout for pages as the page layout. You can create other layouts inside the layouts folder. You can then specify that the page use that particular layout by adding `layout: mylayout.html` in the page's frontmatter. Whatever layout you specify in the frontmatter of a page will override the layout default set in the configuration file. - -## Comments - -Disqus, a commenting system, is integrated into the theme. In the configuration file, specify the Disqus code for the universal code, and Disqus will appear. If you don't add a Disqus value, the Disqus code isn't included. \ No newline at end of file diff --git a/pages/formatting/shortcuts.md b/pages/formatting/shortcuts.md new file mode 100644 index 0000000..34fa10f --- /dev/null +++ b/pages/formatting/shortcuts.md @@ -0,0 +1,16 @@ +--- +title: Shortcuts for Jekyll syntax +permalink: /shortcuts_for_jekyll_syntax/ +tags: [] +keywords: +audience: +last_updated: May 13, 2015 +summary: "You can use a typing keyword expander to make it easier to create the Jekyll syntax." +--- +{% include linkrefs.html %} + +Some of the Jekyll syntax can be slow to create. Using a utility such as [aText](https://www.trankynam.com/atext/) can make creating content a lot of faster. You get aText from the App Store on a Mac for about $5. + +To import the shortcut keys I'm using, see the shortcuts.zip file. After unzipping this file, you can import it into aText. + +There are alternatives to aText, such as Typeitforme. But aText seems to work the best. Read more about it on [Lifehacker](http://lifehacker.com/5843903/the-best-text-expansion-app-for-mac). \ No newline at end of file diff --git a/pages/publishing/config_setup.md b/pages/overview/config_setup.md similarity index 92% rename from pages/publishing/config_setup.md rename to pages/overview/config_setup.md index 8ffcc63..e4fd1a4 100644 --- a/pages/publishing/config_setup.md +++ b/pages/overview/config_setup.md @@ -34,7 +34,7 @@ Note that you can arbitrary key value pairs in the configuration file, and then | **sidebar_accordion** | Boolean. Whether you want the navigation sidebar to use the accordion effect or not. The accordion effect means when you expand a section, the other sections auto-collapse. If you put false, then you can expand multiple sections at once. At the bottom of the navigation sidebar, two links will appear: Collapse All and Expand All. | | **disqus_shortname** | The disqus site shortname, which is used for comments. If you don't want comment forms via disqus, leave this blank or omit altogether. | | **markdown** | The processer to use for Markdown. This is a Jekyll-specific setting. | -| **redcarpet** | Extensions used with redcarpet. You can read more about them by searching for redcarpet extensions online. Make sure you leave the `with_toc_data` option included. This auto-creates an ID for each Markdown-formatted heading, which then gets injected into the mini-TOC. Without this auto-creation of IDs, the mini-TOC won't include the heading. If you ever use HTML formatting for headings, you need to manually add an ID attribute to the heading in order for the heading to appear in the mini-TOC. | +| **redcarpet** | Extensions used with redcarpet. You can read more about them by searching for redcarpet extensions online. {% include custom/toc_id_note.html %} | | **highlighter** | The syntax highlighter used. Rouge is also an option. I think Pygments does a better job. You will need to [install Pygments](http://pygments.org/download/) on your machine or else you will see an error. | | **exclude** | A list of files and directories that you want excluded from the build. By default, all the content in your project is included in the output. | | **permalink** | The structure used for the link URLs. To read more about permalinks, see [Permalinks](http://jekyllrb.com/docs/permalinks/). | diff --git a/pages/publishing/setting_up_iterm_profiles.md b/pages/publishing/setting_up_iterm_profiles.md new file mode 100644 index 0000000..0b9466b --- /dev/null +++ b/pages/publishing/setting_up_iterm_profiles.md @@ -0,0 +1,35 @@ +--- +title: Setting up iTerm Profiles +permalink: /iterm_profiles/ +tags: [] +keywords: +audience: +last_updated: May 13, 2015 +summary: "Set up profiles in iTerm to facilitate the build process. This can make it a lot easier to quickly build multiple outputs." +--- +{% include linkrefs.html %} + +When you're working with tech docs, a lot of times you're single sourcing multiple outputs. It can be a hassle to fire up each one of these outputs using the build files containing the shell scripts. Instead, it's easier to configure iTerm with profiles that initiate the scripts. + +## Set up profiles + +1. Open iTerm and go to **Profiles > Open Profiles.** +2. Click **Edit Profiles**. +3. Click the + button in the lower-left corner to create a new profile. +4. In the **Name** field, type a name describing the output, such as `Doc theme -- designers`. +5. In the **Send text at start** field, type the command for the build script, such as this: + +``` +. build_designer.sh +``` + Leave the Login shell option selected. + +6. In the Working Directory section, select **Directory** and enter the directory for your project, such as **/Users/tjohnson/projects/documentation-theme-jekyll**. +7. Close the profiles panel. + +## Launching a profile + +1. Make sure the Toolbar is shown. Go to **View > Toggle Toolbar**. +2. Click the **New** button and select your profile. + +{{tip}} When you're done with the session, make sure to click **Ctrl+C**.{{end}} \ No newline at end of file diff --git a/pages/special-layouts/kb_layout.md b/pages/special-layouts/kb_layout.md index c207406..c335e7d 100644 --- a/pages/special-layouts/kb_layout.md +++ b/pages/special-layouts/kb_layout.md @@ -6,6 +6,7 @@ keywords: audience: last_updated: summary: +metadata: false --- {% include linkrefs.html %} diff --git a/pages/special-layouts/scroll.html b/pages/special-layouts/scroll.html index 5c449dd..773ec28 100644 --- a/pages/special-layouts/scroll.html +++ b/pages/special-layouts/scroll.html @@ -6,6 +6,7 @@ audience: writer, designer tags: special-layouts last_updated: summary: +metadata: false --- {% include linkrefs.html %} diff --git a/pages/special-layouts/shuffle.html b/pages/special-layouts/shuffle.html index 1b8b49d..5308467 100644 --- a/pages/special-layouts/shuffle.html +++ b/pages/special-layouts/shuffle.html @@ -7,6 +7,7 @@ keywords: audience: last_updated: summary: +metadata: false --- {% include linkrefs.html %}