From 0254db6a442f780698a6a88a96644373787b96a9 Mon Sep 17 00:00:00 2001 From: Talha Mansoor Date: Sun, 30 Jun 2019 20:57:37 +0500 Subject: [PATCH 01/52] docs(update): fix dates --- documentation/content/Release Notes/release-notes-2.0.0.md | 2 +- documentation/content/Release Notes/release-notes-2.1.0.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/content/Release Notes/release-notes-2.0.0.md b/documentation/content/Release Notes/release-notes-2.0.0.md index 1936a231..4baeea35 100644 --- a/documentation/content/Release Notes/release-notes-2.0.0.md +++ b/documentation/content/Release Notes/release-notes-2.0.0.md @@ -2,7 +2,7 @@ Title: Version 2.0.0 Tags: change-log, project-management layout: post -date: 2019-02-09 00:59 +date: 2019-02-10 05:59 comments: false Slug: elegant-2-0-0-release-notes Summary: Big improvements on all fronts – loads of bug fixes, improved W3C conformance, a community development model, and a new website. diff --git a/documentation/content/Release Notes/release-notes-2.1.0.md b/documentation/content/Release Notes/release-notes-2.1.0.md index 3693365d..fae20192 100644 --- a/documentation/content/Release Notes/release-notes-2.1.0.md +++ b/documentation/content/Release Notes/release-notes-2.1.0.md @@ -2,7 +2,7 @@ Title: Version 2.1.0 Tags: change-log, project-management layout: post -date: 2018-02-10 11:34 +date: 2019-02-10 11:34 comments: false Slug: version-2-1-0-release-notes Summary: Add new features and updates From 28b0e0c65a205daa812234170f58a19cddc91dcc Mon Sep 17 00:00:00 2001 From: Talha Mansoor Date: Sun, 30 Jun 2019 21:29:07 +0500 Subject: [PATCH 02/52] docs(add): add article on HOSTED_ON variable --- documentation/content/Footer/hosted-on.md | 32 +++++++++++++++++++++ documentation/content/images/hosted-on.png | Bin 0 -> 2556 bytes 2 files changed, 32 insertions(+) create mode 100644 documentation/content/Footer/hosted-on.md create mode 100644 documentation/content/images/hosted-on.png diff --git a/documentation/content/Footer/hosted-on.md b/documentation/content/Footer/hosted-on.md new file mode 100644 index 00000000..4329773f --- /dev/null +++ b/documentation/content/Footer/hosted-on.md @@ -0,0 +1,32 @@ +--- +Title: Show Your Host Information +Tags: appearance +layout: post +date: 2019-06-30 11:54 +comments: false +Slug: show-host-information +Summary: Show the host of your website +Category: Footer +--- + +You can optionally display the host of your website in the footer. + +To do so, define a dictionary `HOSTED_ON` in your Pelican configuration. It has two keys, + +1. `name`: mandatory. Value type is string +1. `url`: optional. Value type is string + +For example, + +```python +HOSTED_ON = { + "name": "Netlify", + "url": "https://www.netlify.com/" + } +``` + +It will appear in the footer as + +![Demonstration of HOSTED_ON variable]({static}/images/hosted-on.png) + +If `url` is present then Elegant will add link to your host in the footer with `nofollow` attribute. Otherwise Elegant will display the name without any link. diff --git a/documentation/content/images/hosted-on.png b/documentation/content/images/hosted-on.png new file mode 100644 index 0000000000000000000000000000000000000000..74d2096f81485cdd4715ba0664a6231f5ebd1e49 GIT binary patch literal 2556 zcmVutR{OeWJm=QIl!F0|Y2>UQVOoz2b7@o$er{#4)NsqJ=m4*UM9Lfepc#=$;> zwm~myQ#+*9YHf`got>S%y}j$!t^3EBWz-hnwDPmMLJGw{VqpKizCMwCK3_*i$3Muq zQy6Yv82^SNf4Obw^@O;IIo?>??h8beyBqsFudHgHcA$6CWVm?o;sXyn@Z*m^-g)Pp zJ9g~&Cy;?ZH#Rn=ZomEZ+rq-a__q(5{lEUQ_RV!2w@+($c3Ep6s9UPM-SzPNW`w;L z#}ZDBOzn_4IXT~d|NUEUy@gp2=FOYe(9rPCJMaAC%<|oyo_l6Bfs0>WgF~VC+sCO= zE5GQO^XJb`n>I~kGSRcoK6}lFba!{}+qW-%=T3Q~6qxbv&hw*kd);?+Bi2A{Q0Tk7 zVdd^mw|1>fAL<}i#!Uv@E~JO+uDgyxfm~l-f9lk!y1F{Cf@BVh#Zp;Wc{Mjjva+(c z27|%e++3bO9%Y`~Ne1Os^sB3@PoF-`Br;=UWaP}5Gwto|MlxK!e3@Ov#l<`m->5Cj zxLhudui zM$T8-4qP51{m28)Raghjf#W$Ql8|N`So+B)pNK4Eph|#3RZ)O*a*Ti}1oG(UDES3L zg+igs%uJR5#gfq=7(p#DzT4eH1Q;o;p<@sniMghVd|N3zDb1*RyIFSyOB zvvUiy4--1y+t_)r%63gM^!N9JE4 z0?Gu5DpOP^rH`9PbGR62(PS962U$8(ZYBL`po9$KZrpnRoTep-12tWqQ)O0_Kug

Uc7qs z>PH`a6nh;xa)c+$nl%ga9XN2{)ei9=m(@ZVH!?48c(3#vkhQn;dI1hMrv9vMhNJ!&P>;R2U_k9A0>QfExSw zq84fhb@Ru4y_-%B|FE~0Ej)z6DyGDIvkvtk(0aun1LpzM{Q2{N9}b6M0>F3e+V#yh z-(W+*0^arO*MkTfE?c$?P>G3&ENKRTJUp$Xr6rmSbB^>==!K;Ug@z8VgL+N+5UUT) zZR#BMKDMBF<1fQB24qC^5zw4@s1LQoJQGg?KEKszL(xv>FoY?Cm=-crRaJ2|PWbuf zpNk8C0J=?^HbI!VbLRqf+qP|HvpIg}YO%x&3a`KZ`i2b~5a1p&JW5QY$neGX?sqqI zEI8J$$N&?7vpjk5rIl@OukX-62^qxQXUnZB!uWGs*+SS!_8lA?j3xu%r|s`06fg}9C1FjDtnPAS zf<-3=G%^rgC`jMQMM_G~nE(0Ztr^7@F=h9N4}t!Kgc^ekz$A#Ffj~$}N#XEdEH5vY zqRK6?g))3tyLK%CnH38d4Z;kvBw$4bI7zkxMKl>Sbi@IPlljyFvuH}zBna-B(I{j% zmSaNLer^=nBdkgrA`~>I<2xdr@xccl2pQmWMn;CbMF3}bco-d$x*QU!V2VjPSC1tj zgLw0&pMJV@=@J5OFT|Ke2AUlF(mUoCGVH!E3NDP0Q}1A&_X-6{BLlZDu4ubbV@Dvl z@Wb^ygt`$I8Qy>Y{gRRrIU*kAxKg$T1_l6wK&qhh!xl34_U+rDGNvgjD`OR}%K$TE z*t&Hq`ji(QvU250S)wwM8_4~!-x**Re?q*Ho}P}AAed6q$UuE0Ea)<5d$`5x2um=1S-*Qz9@)vlP2c5}9*iE>a^&PB4-kFq*=`l4KTw1~^88 z=%^-WlZ@!h&LA_dt!d}{keQQHH%JPw2$BdHqX)}ZE#3IV16Pp&}h*oT$2n$XF@`PWF~3nN~*1`rQw;Z zbB(cNBm=wHVkCpf5yWwL2QrYt@RyW#r#GZP#U=v-3SpK#7sulLnk2oA8U+Of1R@5a zX~8ZMj$ohx;Drx(yeEhzg#t}N1nXe9qeqWQ10bGOOBfFP*o(d7d#)N82q}~q1ROK8 zA~<8?#*L!Dt6MZ(2hBPeF4x#e0ECFdO@$)EsS)}LDVJt1-&)XHdjdWwOvZ)H3@yA(~WSz!m2`{oGWU0FmC4>V@Wp= zOEM#Z@z@L{isSemh@gSOgUa1nc4u=!8rauS_Zs)IUq+;*`#Uy z|A;XtnCb)TpWCNH0ssI2hC%&XU%kO3bl@2P89)Y*0b~FfKn9QjWB?f;%m57E%JI=M SNzs)60000 Date: Sun, 30 Jun 2019 21:31:37 +0500 Subject: [PATCH 03/52] docs(update): fix image alt attribute warning --- documentation/content/Monetization/amazon-one-link.md | 2 +- documentation/content/Supported Plugins/photogallery.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/content/Monetization/amazon-one-link.md b/documentation/content/Monetization/amazon-one-link.md index 53f87298..96640f8e 100644 --- a/documentation/content/Monetization/amazon-one-link.md +++ b/documentation/content/Monetization/amazon-one-link.md @@ -45,4 +45,4 @@ Amazon Associates states that you need to disclose your affiliation with Amazon To conform to this rule in the agreement, Elegant automatically adds the disclaimer in the footer of the website if `AMAZON_ONELINK` variable is set. It looks like this, -![]({static}/images/amazon-online-disclaimer.png) +![Amazon OneLink Disclosure]({static}/images/amazon-online-disclaimer.png) diff --git a/documentation/content/Supported Plugins/photogallery.md b/documentation/content/Supported Plugins/photogallery.md index 338dc122..1d984c0f 100644 --- a/documentation/content/Supported Plugins/photogallery.md +++ b/documentation/content/Supported Plugins/photogallery.md @@ -80,4 +80,4 @@ The `photos` plugin will process the images, resize, include the watermark, etc This is an example of the final result: -![]({static}../images/photogallery.png) +![Photo Gallery Demonstration]({static}../images/photogallery.png) From b47147b57a11932e0e9abd4124505761de9beb50 Mon Sep 17 00:00:00 2001 From: Talha Mansoor Date: Sun, 30 Jun 2019 21:44:51 +0500 Subject: [PATCH 04/52] docs(add): add articles on site license and subtitle --- documentation/content/Footer/add-license.md | 20 ++++++++++++++++++ documentation/content/Footer/site-subtitle.md | 18 ++++++++++++++++ .../content/images/elegant-theme_license.png | Bin 7459 -> 3200 bytes 3 files changed, 38 insertions(+) create mode 100644 documentation/content/Footer/add-license.md create mode 100644 documentation/content/Footer/site-subtitle.md diff --git a/documentation/content/Footer/add-license.md b/documentation/content/Footer/add-license.md new file mode 100644 index 00000000..aa7f6e41 --- /dev/null +++ b/documentation/content/Footer/add-license.md @@ -0,0 +1,20 @@ +Title: Add License to your Site +Tags: nuances +Category: Footer +Date: 2014-04-22 16:23 +Slug: add-license-to-your-site +Summary: You can display your preferred license in the footer + +You can optionally define `SITE_LICENSE` variable in Pelican configuration. It will appear in the footer of the site. + +For example, + +```python +SITE_LICENSE = """Content licensed under + Creative Commons Attribution 4.0 International License.""" +``` + +It appears as + +![Site License Demonstration]({static}/images/elegant-theme_license.png) diff --git a/documentation/content/Footer/site-subtitle.md b/documentation/content/Footer/site-subtitle.md new file mode 100644 index 00000000..82cf329c --- /dev/null +++ b/documentation/content/Footer/site-subtitle.md @@ -0,0 +1,18 @@ +Title: Add Site Subtitle +Tags: nuances +Category: Footer +Date: 2014-04-22 16:23 +Slug: add-site-subtitle +Summary: You can add and display a site subtitle + +You can optionally define `SITE_SUBTITLE` variable in Pelican configuration. It will appear in the footer of the site. + +For example, + +```python +SITESUBTITLE = "You can, you should, and if you're brave enough to start, you will." +``` + +It appears in the footer as + +![Site subtitle]({static}/images/elegant-theme_site-subtitle.png) diff --git a/documentation/content/images/elegant-theme_license.png b/documentation/content/images/elegant-theme_license.png index 289d6e071c447fe4501e829bac10ddd516fdb229..f7127be4b35d43c78896713e2a574542063b1f7c 100644 GIT binary patch literal 3200 zcmV-`41e>9P)87*8r{oTm#@5z%_tt09*sO2Ea9dYXH{(xCU?y zfNKi426%4H!P}A~2IGIt+O}=mHpaGXd*<1;ZQH!Iz56>;=iKenJ-B<yYIgH`|rPh{`u#3?b;Q|Vp!?;@#6^58Ta(`y!YOF2y51?;m3CUbxAH=y0oyc zFuJvAX=&@%uaD4}QorGcuIJYcKDlb(!6kja%hBMBdrPWH$nS0+5rr46-+z9Lsy$bJ z-TB?&31xOfsI|xs{joyb?ko+$Ynz4(+bov`2MRzz%0C~Uj3T_Zw~Y|qkjgDp{%~Z1 z*xuMOe9wYjt1BSYAIjG%L16XI_l-r!?SFMfjNO^)m9aD7$HZzQ2Pypc?V<6?9@{_9 zH7b?rh8u1e92`Ur27{xcqoU0zE-o%ADnj7VX0vs6c4Cv0lVdO#yk0Nd0WnonR5+bZ zzu#Y3S(%@oZ#J7n&%&s$uLl83nX!y(fHfM82*83+U0qEK0wg;-JKT~W=yW>bX>4o^ zcSac*8MH;nN_!k(Ok*PB8dy&x=yJJ;P=PG2xKM3vEt>fFc)>Nw1Oef3WMo7vp`qZ6 zh7V=Wq>I1vTFeON$_?C^+>N~coMyAnA7Y9-Ke@)pMZ|66@r5{TEYEH-i{Ey4fRZyi z0$94dL2wXc2$%57ot9Q_N~tv(&-X{*)DPI{7l;H6*BySjt}i{M#GyF(UEEK^4))9yB*fiuI^2R|sve@}qqc66?AT~rgKz?q` z;LSgEOSy)`3CwxEqhU6_(jem+B_?4*SacKP8jsi<_OPzsjx2li%3$c8P8RD*JFUnO zW&|?n^DfG|tU|-4VSt8BzAV?U)q>(RW*^&|-)iCHD8p8UO3QhsR4=+MseP1OLsRqB zS6@jdsHn#ue|*c9E$h~;d+4Eu>~=fUK;!f2r=KogzWkYIo+NN*qoz#-HsQqk$4V3-Oc4wlo#&BTXD;;jlisyq{8pH>KGT z?VRJ26e_Nff!dLw4%Z1>gNx-c(;xs#p<*L=4UnW7Bh?5LGEndD7@-YeYG;P}zD0c- zlV@4AFGnMGo?I54o3h14y(y(e2kw2(!F8L>0Gg@vc5ForDnkKPk2`Y}UKdv#f^5e*|3 z8{7NUfpMk)k%g_y5#GTm=a9CDS-E`_TyyN$v0pi}3m!>sAPT^LEq@>^2nxc?EC@3* zGcz+Y3yztYneTQ#3T;x zfPz#^XDh&_NcYBGm8-4?<@MMLAE4H5de3$SYG^cG+bRfkCE< z8rnjj2?a0<%fN{;q@$lDg&%>@KCEdh6Ik|^@buG9!9X|2Ps@QhD-QTWxyKIFPMBp5D1?-2C4gp--_CpE~=v$u06J0H5CTypc5wcY#vYWPU#V2zxY=cS^N(k<3>Y~lsJ z2|F;>&Ea%70%7Z;AGsK#Y=R-6e4s~m27e?x{K?u2pIln*m5=}2Y@-HZjj`;P8nC3I!TG?)H@{R~GpA&A_bt1#9PC2h!n;@g-Rcoh2vv7n*1Som_6HBa6B~=!1 z=`%}#$Wb@XJM5ZS!LM;xlc_sclYR}yO%bf&Y!BA(olY=o(V9ILQ}4W$2fR}8g;m*1 zYBfqic6b`u_Nr)Ftm)XSu?9PXsyUs9(2z>G9jICaAFdFipvFLt%FaNXvmRN@AhwH( zoqW$ixIYkUoT-21%XZoAzA0(NgUxXYUHvIw4U!_ezW(}a@|G=IbX8;>^pSPy1qrF6 z(P9lwA=Q0cy?V7&Oe16W?%mi#i#1X1!5WR0oHo418UiFDyG&XOJ@YE35h8zNF}0X>F-{F@T01S)DE>nVN?3D^N7|5d z{Ih0#-`YD^qlD?f8oq=RK`TN4*G9>xV9gOX%~e;{EWlzkAP7%=u})Tu!y0?Vf}Qk_ zS(D0Vi^)!#j5D7>YG{zW@Gv2_~aFZ@>MvG*;0l96a~kcOQkB zGiTOVqn)f}69v$qQ9_^~d*!4*Gi!O&SW_$eSR0h;5?c-#7*FZ{NOF|BgHE;EVPR%2Q(vU^UPzco5~*GJ(Fa-g=d)YMg`hqu(icoR&Bi z4ZbOiLk2qdG(?g@uA_XEd#Y&N5Q2Xq038U{xa(L@&$kwO<`o>`HP)_qae4kwMIlCN zKoLDXuUb1g6nYATCF}MEYuu|=Oa9=WMW*&Cu;LNiF74u-x*$AAEmNkhElUZ>5M^NG z8x(^+#{r*ix^HwkELE1u#?)w^{k?_0l#_l~L%s7hB#qwA!=T=3O4K{vSw*<>`3A-wj_8Z5Y0ZU<`j^2j;bI^1fYM|MV6n*aiIPf%TN&1ky_ z^&aNIG!qj3LD&qp49Ah}64MZ1Pp z*@sjxYzR`BwVtnvw~z7jUB2tOIJ6DtoHS?*_ukdvB|?9UK~pvwE?5UX2nEDX(h;KJ z;9-d%UuyvneBk39B*39cBVVI;R9gWH6ig3qUH3aHq$}*$Zu63qS9SlANVg zK<*sRJELW2ImiFjN4EcM1=or3SSd>V-&AB?3?HoMkb787jGC3C>`p2h0$%We&)?Q} z`*vUf01N|BG~=~&|8Xv*6BG*i-Vom*aW@S3Q2?|CKx+W40ni#iYXGeQ&>BE%fZtV; m2C!=Yy9VG&jk$6(z%v{BD_G0000-Kdan^<^e#G4f+(YRq6=e0B6?@^E@X5=bTNn;z4u-xM(>>; z&-1+RyWZcozV-bv=iX;u`?~LYu4~SjbJh-dt15?w{Tv$&4Gm90UPc2A4dc@tc6y9{ zcSOe0aH646q7-B#wLGV{CTJhrk?1tHnd7AVo|1Pt&B@?9DxVw;?ejgz0^P+?kNyGw z7kwZ9Z?)M1zAYM>@zdbGCV;ZaqXs?lL^K-2ohtWUI*fycCUL)vJoi7;=cBt_{zZiw z+)*sh`}N&1gYJ%v_wYUgZR2h~|6`Ko3L~uhZ-^#w1CMaZF4Th;78V}gef|RDMTLd7 zh`Y0U@PE?xY5%_(+k0Xc`kT1@mL>HPhlQhNUz~=Pw!Gey7;itch+j`vS2ru<1!t`i z1L#NguV|V8CFQKzU!T3{!iYxyBsmdt?g;nn9JGC*_yl>!w@ZvoVQIP0;I+Gb*}GNz z7z6!_1kKaOxuAccdjb`3&;1>eNBj%j5e4Lb%l`^RgK7U0(%}AQroV<`sekAH_tc}C zW`07|@v2BFA!mY8hwr^w37(?S_S1YL{*8Y2yP?$%wkejn{Y}2Tyvurg>fcsS<{ol# zMG?IOc@jHVaWs~5>{is3aRYkqQyXX834;gl-0eGK`u*$$G^r^G)(k|Uc8j8GBO2Uq z42A8IyUb(rwzU&#;ed&@(e?Fpx~}22SXhoLrC#h_lV-~4$6+L6Z`I+HNHdopSE_RL z$2T*f&qQThZJ`z5|W`Mn=u0{nDhL zi$r8Za)qi&^mc@0p=&4Od7Y;IO!0?Z0a+KIkgUj_o)@ZbHRVU{;d&@>yYi0W z*;0X*f%us-s8|g0hTsDiVH&Vxz9VZ# z1OD_^s7H3Igw7Enj&3z|#yBki2%F_dx!Zwl&d;8`cM^@0TRy7N&)C)0`_+m(8*wx-$&{cCL84J6^-jB^j)2^Guppvnr^WzaT*nvEc7p8#)r<1 zBn~7QvtY3|EjZAPj$ek3;@tfNRB}NT@`xm}0B-}>%*PXYxEx=P$!jHqhX1iOW+HLE z4qufi)x zTpq9%OdNsEDHdhEp!@7>qU#=0dVIQgxlyM(tN^<>9V>;bF=O>_g_Hc+_pD+O386^_ zc%5UE`*dt8M)X_sS^?_x%MjW{$~*os{nJ-|_KrN7s{LJQBASHGkQk4iSlQ@H2VXTy z(zepAM_WZshc}~kmc^%R{OHG0F2^0CMd@l3>YS6=q1MhLs2NG;iZ=}3lB-uH3#{KN zz1BE66gv06l{SzkZ~GLSu6Txc_5hk)ZGpL_fR`{kQDcR33X?-XD40h|~{RSa|o{Oa@ZpV>@ z$PgzCW{T|1k)PTrv9}pLOr7YeNyjPt1`6}WLr#WlEP+ozUs*3HRT1k=I@eWu=f`1* zydQhaUX007EvGd2HY#>1c|_^;4^25ep~e;-dvvSQxLEmVeK2oc+r$L^94Ap7naKXL zDP_dDVofH;9xxX)Q>EgxjR2`lHjwDjr0VasBg{mR_1I)T)8}3UZs^& zm4-%CU=xLxF#D8`3#W-e?>^3?q__xUT_ zpC@sBj2P1!+Rnd<6zA1?f2E4}MmDt-5N$rA8@unJ z7df_{7%LSAQ+1KBt~_H&W{TmMo-9i$MbudR9;wS7B-@{#44rXSMG-OTibr-9PkG~I z{ZiQYd#dqw&Dj_@!+6oSZBZR!+D@O7a)Np4IMx%}fy!Q+>?i|}VdNSG?dG>|i#@t} zRY2|nVczH^(ZfF~acmMZyjb)$ zV39Ae#U>2f{F_YT2`0I7$Wiu-aPUyWiRna`V2B_gVUGpTlxL=!TVK&8&uh9H%V8Q? zCA2U8_zIQ!DUMj@x(grX-=?F*<$PrwQO1tY6?$o~vG8nk)3IZPzs2fWN)^#I(4wt5 zg&d4Nx}Fs*#1rUS8^3Oms;a|qR$+auu2hS?ws!{2)Wx;NvHMgg^ev$cYQK0a@r@xP z{~Ksfji8c`CaaATcEI7q5!+L+m3-NfRr&>;_2^+gDQCGlecnYqTRLu35t>3cX<~CC z#4e7qJbH4#Y*XJzP=uG^IIO>vE3S1#Hy63G_`JtTE1YQ4y$;tbQfphqB`UI{adh~K z$-wSP+tv#f$wP}V$K`q9$a&$4*zG$WeE&k5tDG{)!kyvv2f8MA^?@fo1}bI?COu@=pJn*LtRnP9e_t*8I5%1n+v-;9Jv4p*Q`FI==_e(wtp@6Q zhFw*>s<&KYoGx6d2pExcwplx>v}{pH0Zr>o{LL@x7JGWNluu4MsA&1bZ2s~|2}mIX zyTC(avy#F+c1Uni{Y#ozKZ89VinPi;X!89`wxr%uz(JcuxUZe-18_3dk^Rq`P2vhz zjC-;o+vEuaxm*BuG5v<)vOO4yubeGDV4~)VKl(Wp9p>%iGMOqH^^QE$md}?Ubf?3vpYF! zTL30a(L9wT87*>=-+AWX0LL&&mvhfFmB-F}?#TIsi`OYn#vBcs=??GuxDx6`v~ z;r5y!;jvb6(8~N!-1aQvZrbhYNBnYycXES7U6e-eB2ls~+>Gi(YLv5z8nJi=jIlqw zyw_uk`*G-)-hmTZHZ5G(ysIOuG+x=}5o@3xt;D7cX($ynlxi?budqqHG=TI8jF?54$$`8VEcJ5J*5_AKRIKoHJ)&^~SNZ0TGak{;8`+&XC{_UOO1K-H zV8 zc&l))jdv{e^VNIDY9=1`b@IPBAbya=@+vVY5L|$i9lQ#$`W}>;9k1#mm!J#RDsuAN zMGgTrXUTojRHYGZho6ErO>R4DM9P3Y$Bb0?tv%+cbV97)8{^S1LFZfi43{=w?7+s< z4Te-u>KlCi%)J@VQDBk}%iLHwsFP2I@`@N&|-k&v1EX1L@T= zaY#T^<~ZCB;kCgj<}!De{AV6hvi2(sU<%#a^)Ny&G0jocRE5`g)9<83g>I@+#aqVa zijAVt0)b1=@x=0&e4X#;+Rpedv_r)hX<3~vc^aGb)=&1o?$K1``hNF+3g%rkSww9t z&yR^W8#>kKmqcmhi4Wpn>8+09h^S8~PDjB31b$_aIjPRYa5xe0&Ee^R>f7P_20dG$~%q(jD$rSp;_q8M$ zKDCLg@#6F!oPMV!GW&%praTbJOI?5C=%e`%cuWsL06$w%^rYx=8)bJZpZv^hAryB* zWzxYMp^C~7e|qePc-#k*(k2w+!BoI}ibgw!h59~u{QSoEd(tJfx6a6P#}Ap?bTSYa z>PzEE^BdeODS!i)Y53g|#z7+OziUe5$wVFwtj9|dXiA+zHs`2@S87cOhe<+Xa2JXBD|Sx`fwz!t2@Z@n%AE8e4R_&m%4ns z-Iu?+9Jz-ZPuJf)bX33N-YCOtlIlzC&=`o>CGzDm={AMT(A|A9 zkS1-e0%`cs@x*D2jaSDDVYZ1 zA@jib;1x_(0xnK>D3d%NFNU#Puup4ht7)$VwIVwBa}0M3_yA>86wE@Qn?pzLUA+ZamR~i59B*0x{ip3j8ugl z2rP&hcvp!-;5rbst}q03VkB&0Y#J(Hq4Nq(PE9VRG^b-uC)c3EO*bMNxb)@F4@R!X zpyMRAELcUHcjcW7;)hT9M{Fwp6?pzvoae{70|< z-N8q8Dt&nlS{h!;z!!koEQv2cJPXyaKpC?5!ai2-jKnS*Fd=>NmzteVEGv6_3zdqK zM)k>{YFCDDp&=WxWM)#Yr5O!N#p;x*hm4Mi*0>56MGm)HHoE+RtdI#OU|?5FZZGzp z$&)WD4ZUrC`|T!iBaA~sM=iw(C*eir3Izj;Q1wP!wrIdxF5CZfW6rHu`N`+)NR0I; z60-eY?7P9U<(xl?|74DMQh)Y73CF5QaIuM{R7B9G+t+2dtalo=qV3hSziHV)?O9Z% zk0pMLQA*GFx*=?<59H+!g+J2QY6V zKth<=E3OR78M+jgYSFwz_X=@VyZ0Up(f5>1033i2;V&iQT>4iJ3^XLVEymZzRl^S) zEx{2vM!^$dj=WL?AJ^upw>+!0-aA&el)b11Dw-`XR?Zd2E6MXp*0Ft>u$u>pgEZjo zyB|7Mz@&rQ9s}WCgWRJmt;OF&)w+4$ux5E+XNWtJ6y?z5K_v06FpRCB zUc~Sj9M5qf-9P=%>C%a-X+zeUXat8)@+b9tkgGsp`6x4)|VcabY<@E3;awRA2^#^5DgzED9C--Tc6;rolz8eA&kQ%B2JB*Q!jdA`j^ zmBEidM66&X;)vXTDG`ZV#X5Q^TlE4NPo7R_d|Q*2X|fnVrU;W>LRBtdPSez(R!`$&PnY z^&mKq;hQ5p78ww+)du{n`heR=n0^cU9Jk$pW&Us^o)8P^hh-o6YB@ledtL~a@FCVln(}eXT9hpc^ z_=%=19~~*fF@}pmaxnR`$s52@N!EP>DsY23)Hq-V+Q9cn{YGGNm}56h=DOi$HN+JE zc;t_;suyD>k3Ly5QV}Lw#)j{`Ghg@-)0w*-)L}|bDhv_Op`1O6?c!v6L3W~s0e83D zHz=C2&r~tze}QFDHB=OM)SyqX)q7P<@tvKg45AU+Q`1A7T2}Fff@v*ov81&mLpZLi z#*H6wXBWNYlf0JXA6I;bQ%^4o@rK$!R7h0k^5B&~x{u3w z?X8UrUT+z%mkJzL!R-}d5kFu{mzbZ;8Nvq)t!@K1c+#j zwWeVn;)Cu)#opSxvo^JvyyORVzz5q6d=0N~+G1Xg^U0g|=tA{Ltv+L~5(!6h{X55dz}veBpO5_t!;}PxHc4W~>i*s##|9srPv%V>qvO zcdpwQkTcFa=z6H;uJ8-(Wr!QQ=lQY1K%4i7V=6bgX970-{rReM{eFC07f_np&9sh6 z^QAdaz*MVGZyB|1voj(VH80v=-OA^mx z+c3YWn+YGdEy}*GQs&O+gY$_S#X2S`E=UApytnqk9{;}a$Sp?YeCN2?3>b-rGMn#q z?g%@R5?m@Q+h9~XYCXnQe%z+Q*zl$9pkBrE;b75Wqw|Ir2=nfu+EcV3oU+gZ$f&|# zsVj>msgPEpdReLZOIoOa#B-mf%FD;8C5Gf9I9*wfRZPK4FJxN7*dF`z(+(^5i9T6Q zay=JdEe(mTxaMK^E!+1U ziGV{l0+PQ@2&r*KUB8@OGpUtRxV<3W*=dvT6URD2Tt0vf1LxXW&(qf6di&hz9=iF3S^gAOelp-WU*RHg%PtGNU@A z|CDLAP-U3SyGq;oW$tUSxA3?<`KtN7yZ@o;nLVb*;A5DHLErpQO9akpD38fVSPAV` zXhQ^A4fpesaWHA`fVaGo1bDtmc?OHR_5(SX?zBrg4L7IyQDFCIu!OBRXWG=Cer2RF{Uh{IcqJ~pq&-0op+CCE#<%Ic=PTW z`E}3m>@3JMEL}~WEAvcnP0(i7Ou(72nYiuI)~~LEWde7fo58wzcM3amCW9&8pDw-$ zJEtG8OMjc641@3%-180O%~DfA0+rKY$`*WHHjc=n6x+r7?!KW^WIUr%=5E#_ZdJXN z=jXI5A%2(-dRlWf6i_tPYI&5Z!WxP`UV@zK$x3mP#tB;BsYK8HocDXAzCs%>0~q-Q zK_N0&9fKuu?r!X;&VhHJBeJaODsd)L{vdm|ZAnGk<6>qMf5RxmNFmv8G4>BWt$@~# zT4N%yCl-HbC6oV@q}lpU^ayg7nlbV`>5JbuO}A~GeXVoS@ouM7j^M;ma8Cf4ZLCzs zheuiYHs-Fn?Eu_vVndZT5m8L)D>-a~lQ+^=2Az0>g_G&fWuKmaZ{j0>9>bS&or%)1 zEh}6H!8Ts!#^tGYsoiCD4AQ+Q7i#j{DVmB=AKCSa#8b9a^t1t@hh~G`aW%`+A)0|h z`%o3`0MizmmDY!04f7y@a~ORPuzdZe!XJPmDRzKV_FI-4lIEbCGubRy;xhSXo4D8_ z1BK8l1}c7z@=$7$;;#lfQR()7D@lAKH%Rk0zP}w&igAg7YnNQ;N~=~b-LzAZ4=oo6HYOMfN!_;v@En_gCDox~Q*`ZvjPKiuu%9KhO G`~5%khi_s4 From b5d5bb109a56b071ff370c76b1dea0194da62a44 Mon Sep 17 00:00:00 2001 From: Talha Mansoor Date: Sun, 30 Jun 2019 21:46:30 +0500 Subject: [PATCH 05/52] docs(update): update articles --- .../Elegant - Pelican Theme/misc-features.md | 37 ++++--------------- documentation/content/Footer/hosted-on.md | 2 +- 2 files changed, 8 insertions(+), 31 deletions(-) diff --git a/documentation/content/Elegant - Pelican Theme/misc-features.md b/documentation/content/Elegant - Pelican Theme/misc-features.md index 388261ec..c74db7d1 100644 --- a/documentation/content/Elegant - Pelican Theme/misc-features.md +++ b/documentation/content/Elegant - Pelican Theme/misc-features.md @@ -1,35 +1,12 @@ -Title: Few more features of Elegant -Tags: pelican-theme, web-design -Category: Elegant - Pelican Theme +Title: Web Safe Fonts +Tags: web-design +Category: Appearance & Style Date: 2014-04-22 16:23 -Slug: few-more-features-of-elegant -Disqus_identifier: c8et6bu-few-more-features-of-elegant -Subtitle: -Summary: Three more features that are unique to Elegant theme -Keywords: - -[TOC] - -Here are few more features that make Elegant a unique and powerful theme for -Pelican powered blogs. - -## Add License to your Site - -You can put your license string in `SITE_LICENSE`. It will appear in the footer -of every page of your site. Here is how license of my site looks like, - -![onCrashReboot site license]({static}/images/elegant-theme_license.png) - -## Site Subtitle - -You can also define `SITE_SUBTITLE`, it appears in the footer, before site -license. - -![Site subtitle]({static}/images/elegant-theme_site-subtitle.png) - -## Web Safe Fonts +Slug: web-safe-fonts Elegant uses commonly available typefaces in every style rule. It has a list of -closely matching fonts in the fallback list. For examples Baskerville is the +closely matching fonts in the fallback list. + +For examples Baskerville is the first choice for headings. But if reader does not have Baskerville installed, Garamond will be used. If that too fails then Georgia will be used. diff --git a/documentation/content/Footer/hosted-on.md b/documentation/content/Footer/hosted-on.md index 4329773f..513ccf33 100644 --- a/documentation/content/Footer/hosted-on.md +++ b/documentation/content/Footer/hosted-on.md @@ -1,6 +1,6 @@ --- Title: Show Your Host Information -Tags: appearance +Tags: nuances layout: post date: 2019-06-30 11:54 comments: false From b4c563d400b0193f394258a715e2a33f509e4d2f Mon Sep 17 00:00:00 2001 From: Talha Mansoor Date: Sun, 30 Jun 2019 22:01:37 +0500 Subject: [PATCH 06/52] docs(update): add SEO & SMO category --- .../claimsite.md => SEO and SMO/claim-site.md} | 6 +++--- .../seo-social-media-tags.md | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) rename documentation/content/{Elegant - Pelican Theme/claimsite.md => SEO and SMO/claim-site.md} (90%) rename documentation/content/{Building Readership => SEO and SMO}/seo-social-media-tags.md (97%) diff --git a/documentation/content/Elegant - Pelican Theme/claimsite.md b/documentation/content/SEO and SMO/claim-site.md similarity index 90% rename from documentation/content/Elegant - Pelican Theme/claimsite.md rename to documentation/content/SEO and SMO/claim-site.md index 0d0690db..60701832 100644 --- a/documentation/content/Elegant - Pelican Theme/claimsite.md +++ b/documentation/content/SEO and SMO/claim-site.md @@ -1,12 +1,12 @@ --- Title: Claim website on Google and Bing -Tags: pelican-theme, pelican-plugin, claim -Category: Elegant - Pelican Theme +Tags: google, bing, crawler +Category: SEO & SMO Date: 2019-06-27 Slug: website-claim Disqus_identifier: hk9m5eq-website-claim Subtitle: -Summary: Use Pelican to insert headers to claim website +Summary: Use Elegain to insert headers to claim website Keywords: --- diff --git a/documentation/content/Building Readership/seo-social-media-tags.md b/documentation/content/SEO and SMO/seo-social-media-tags.md similarity index 97% rename from documentation/content/Building Readership/seo-social-media-tags.md rename to documentation/content/SEO and SMO/seo-social-media-tags.md index ad4e7cd5..92896c45 100644 --- a/documentation/content/Building Readership/seo-social-media-tags.md +++ b/documentation/content/SEO and SMO/seo-social-media-tags.md @@ -1,6 +1,6 @@ Title: Search Engine and Social Media Optimization -Tags: pelican-theme, social-media, web-analytics -Category: Building Readership +Tags: crawler, social-media, web-analytics +Category: SEO & SMO Date: 2014-04-20 16:31 Slug: search-engine-and-social-media-optimization Disqus_identifier: 7mh4xjn-search-engine-and-social-media-optimization From eaee65910c2c9db25da6c89947f7f9717b96deff Mon Sep 17 00:00:00 2001 From: Talha Mansoor Date: Sun, 30 Jun 2019 22:57:10 +0500 Subject: [PATCH 07/52] docs(add): add articles on comments --- .../Building Readership/disqus-comments.md | 47 ------------------- documentation/content/Comments/comment-id.md | 27 +++++++++++ .../content/Comments/disable-comments.md | 22 +++++++++ .../content/Comments/disqus-comments.md | 13 +++++ .../content/Comments/invite-comments.md | 24 ++++++++++ 5 files changed, 86 insertions(+), 47 deletions(-) delete mode 100644 documentation/content/Building Readership/disqus-comments.md create mode 100644 documentation/content/Comments/comment-id.md create mode 100644 documentation/content/Comments/disable-comments.md create mode 100644 documentation/content/Comments/disqus-comments.md create mode 100644 documentation/content/Comments/invite-comments.md diff --git a/documentation/content/Building Readership/disqus-comments.md b/documentation/content/Building Readership/disqus-comments.md deleted file mode 100644 index b591f3d7..00000000 --- a/documentation/content/Building Readership/disqus-comments.md +++ /dev/null @@ -1,47 +0,0 @@ -Title: How to use Disqus Comments "Elegantly" -Tags: pelican-theme, pelican-plugin -Category: Building Readership -Date: 2014-04-21 16:39 -Slug: how-to-use-disqus-comments-elegantly -Disqus_identifier: 9jgwmy8-how-to-use-disqus-comments-elegantly -Subtitle: -Summary: Elegant offers Disqus comments out of the box with few unique features -Keywords: - -Pelican uses Disqus for comments. You have to set `DISQUS_SITENAME` to Disqus -site name identifier in configuration to enable comments. - -But that's not all. Elegant raises the notch up with following unique features. - -## Invite Visitors to Comment - -Instead of just throwing in comments form at the end of every article, Elegant -offers you a way to write introductory text that would appear right before comments. - -![Introductory text to the comments]({static}/images/elegant-theme_comments-introduction.png) - -Set your message to `comments_intro` in the article metadata. You may also -define `COMMENTS_INTRO` in Pelican configuration. - -Write whatever you think is appropriate to invite the visitor to comment. Be -creative! You can even put a link to your twitter account or newsletter there. - -Elegant first looks for `comments_intro` in article metadata, then for -`COMMENTS_INTRO` in configuration. If it finds neither then no message is -displayed. - -## Disqus Thread ID - -Most Pelican themes pass article URL to Disqus as the [Disqus -identifier](http://help.disqus.com/customer/portal/articles/472098-javascript-configuration-variables#disqus_identifier). - -This puts you at a disadvantage. If you are forced to change URL of an article -you will lose Disqus discussion for that article because Disqus identifier for -the article will change too. - -Elegant offers you `disqus_identifier` property that you can set in your -article metadata. Set it to any unique string you want. It won't be effected by -the article URL. - -If you choose not to use `disqus_identifier`, Elegant passes article URL to -Disqus. diff --git a/documentation/content/Comments/comment-id.md b/documentation/content/Comments/comment-id.md new file mode 100644 index 00000000..2b85cd22 --- /dev/null +++ b/documentation/content/Comments/comment-id.md @@ -0,0 +1,27 @@ +--- +Title: Comments Thread ID +Tags: interaction +layout: post +date: 2019-06-30 22:29 +comments: false +Slug: comments-thread-id +Category: Commenting +--- + +Most Pelican themes pass article URL to Disqus as the [Disqus +identifier](http://help.disqus.com/customer/portal/articles/472098-javascript-configuration-variables#disqus_identifier). + +This puts you at a disadvantage. If you are forced to change URL of an article +you will lose Disqus discussion for that article because Disqus identifier for +the article will change too. + +Elegant offers you `comment_id` property that you can set in your +article metadata. Set it to any unique string you want. It won't be effected by +the article URL. + +If you choose not to use `comment_id`, Elegant passes article URL to +Disqus. + +## Legacy Variable + +In previous versions, we had `disqus_identifier`. Though Elegant is backward compatible but we recommend you to change it to `comment_id`. diff --git a/documentation/content/Comments/disable-comments.md b/documentation/content/Comments/disable-comments.md new file mode 100644 index 00000000..c2150287 --- /dev/null +++ b/documentation/content/Comments/disable-comments.md @@ -0,0 +1,22 @@ +--- +Title: Disable Comments +Tags: interaction +layout: post +date: 2019-01-12 16:29 +comments: false +Slug: disable-comments-per-article +Category: Commenting +--- + +If you remove your comment service configuration, say you set `DISQUS_SITENAME` to empty string, then comments will disappear from all the articles. + +Sometimes you want to disable comments on selected articles. In which case, you can set `comments` variable in the article metadata to `false`. + +Here is an example, + +```yaml +Title: Disable Comments +date: 2019-01-12 16:29 +comments: false +Category: Commenting +``` diff --git a/documentation/content/Comments/disqus-comments.md b/documentation/content/Comments/disqus-comments.md new file mode 100644 index 00000000..ef4f1e0d --- /dev/null +++ b/documentation/content/Comments/disqus-comments.md @@ -0,0 +1,13 @@ +Title: Enable Disqus Comments +Tags: interaction +Category: Commenting +Date: 2014-04-21 16:39 +Slug: enable-disqus-comments +comment_id: 9jgwmy8-how-to-use-disqus-comments-elegantly +Subtitle: +Summary: Elegant offers Disqus comments out of the box with few unique features + +You can use Disqus for comments. You have to set `DISQUS_SITENAME` to Disqus +site name identifier in configuration to enable comments. + +That's it. Elegant will take care of the rest. diff --git a/documentation/content/Comments/invite-comments.md b/documentation/content/Comments/invite-comments.md new file mode 100644 index 00000000..3dd92814 --- /dev/null +++ b/documentation/content/Comments/invite-comments.md @@ -0,0 +1,24 @@ +--- +Title: Invite Vistors To Comment +Tags: interaction +layout: post +Date: 2014-04-21 16:39 +comments: false +Slug: invite-visitors-comment +Category: Commenting +--- + +Instead of just throwing in comments form at the end of every article, Elegant +offers you a way to write introductory text that would appear right before comments. + +![Introductory text to the comments]({static}/images/elegant-theme_comments-introduction.png) + +Set your message to `comments_intro` in the article metadata. You may also +define `COMMENTS_INTRO` in Pelican configuration. + +Write whatever you think is appropriate to invite the visitor to comment. Be +creative! You can even put a link to your twitter account or newsletter there. + +Elegant first looks for `comments_intro` in article metadata, then for +`COMMENTS_INTRO` in configuration. If it finds neither then no message is +displayed. From 17edf56c873305e85b08254412bb3da013ca9c2b Mon Sep 17 00:00:00 2001 From: Talha Mansoor Date: Sun, 30 Jun 2019 23:01:12 +0500 Subject: [PATCH 08/52] docs(update): rename file --- .../misc-features.md => Appearance and Style/web-safe-fonts.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename documentation/content/{Elegant - Pelican Theme/misc-features.md => Appearance and Style/web-safe-fonts.md} (100%) diff --git a/documentation/content/Elegant - Pelican Theme/misc-features.md b/documentation/content/Appearance and Style/web-safe-fonts.md similarity index 100% rename from documentation/content/Elegant - Pelican Theme/misc-features.md rename to documentation/content/Appearance and Style/web-safe-fonts.md From d2d144f45a85298e2be993986eab4ab9e307bc60 Mon Sep 17 00:00:00 2001 From: Talha Mansoor Date: Sun, 30 Jun 2019 23:13:45 +0500 Subject: [PATCH 09/52] docs(update): extract content to their own articles --- .../content/Code Snippets/code-style.md | 19 +++++++++++ .../line-numbers-code-snippet.md | 7 ++-- .../content/Comments/collapsible-comments.md | 33 +++++++++++++++++++ .../Elegant - Pelican Theme/elegant-theme.md | 26 --------------- 4 files changed, 55 insertions(+), 30 deletions(-) create mode 100644 documentation/content/Code Snippets/code-style.md rename documentation/content/{Appearance and Style => Code Snippets}/line-numbers-code-snippet.md (84%) create mode 100644 documentation/content/Comments/collapsible-comments.md diff --git a/documentation/content/Code Snippets/code-style.md b/documentation/content/Code Snippets/code-style.md new file mode 100644 index 00000000..e98b8bf7 --- /dev/null +++ b/documentation/content/Code Snippets/code-style.md @@ -0,0 +1,19 @@ +--- +Title: Code Snippets Theme +Tags: markdown, reST, code-snippets, gist +layout: post +Date: 2013-08-27 23:20 +comments: false +Slug: code-snippets-theme +Category: Code Snippets +--- + +Elegant uses [Solarized](http://ethanschoonover.com/solarized) theme for syntax +highlighting. Line numbers have a different background color so that they +appear distinct from the code. Here is an example + + #!c + int sample_function (void) { + printf ("This is a sample function"); + return 0 + } diff --git a/documentation/content/Appearance and Style/line-numbers-code-snippet.md b/documentation/content/Code Snippets/line-numbers-code-snippet.md similarity index 84% rename from documentation/content/Appearance and Style/line-numbers-code-snippet.md rename to documentation/content/Code Snippets/line-numbers-code-snippet.md index 2825af6a..a4485898 100644 --- a/documentation/content/Appearance and Style/line-numbers-code-snippet.md +++ b/documentation/content/Code Snippets/line-numbers-code-snippet.md @@ -1,9 +1,8 @@ -Title: How to display Line Numbers in Code Snippets +Title: Display Line Numbers in Code Snippets Tags: markdown, reST, code-snippets, gist -Category: Appearance & Style +Category: Code Snippets Date: 2013-11-05 17:36 -Slug: how-to-display-line-numbers-in-code-snippets -Disqus_identifier: wmo972t-how-to-display-line-numbers-in-code-snippets +Slug: display-line-numbers-in-code-snippets Subtitle: Summary: reStructuredText and Markdown have directives that generate line numbers for code blocks. Use them to display line numbers in code snippets. Keywords: codehilite, python-markdown diff --git a/documentation/content/Comments/collapsible-comments.md b/documentation/content/Comments/collapsible-comments.md new file mode 100644 index 00000000..66d46995 --- /dev/null +++ b/documentation/content/Comments/collapsible-comments.md @@ -0,0 +1,33 @@ +--- +Title: Collapsible Comments +Tags: interaction +layout: post +Date: 2013-08-27 23:20 +comments: false +Slug: collapsible-comments +Category: Commenting +--- + +Readers use scroll bar to track their progress when reading inside their +browsers. Very often comments take up more space than the actual article. When +comments take up more space, it throws the scroll bar proportion off and reader +cannot judge his progress correctly. Hacker News hosted [a +discussion](https://news.ycombinator.com/item?id=6246777) on this topic. + +> tons of online articles list comments on the same page, so the scroll bar is +> almost a negative incentive to keep reading. "I've read this much of the +> article and I'm only 1/20th of the way down?" +> [user stops reading, unaware that there's 450 comments and the article is actually pretty short] + +Elegant keeps the comments section hidden by default. Reader can hide and +unhide the section by clicking on the comments section. + +This is how comments section appear + +![Collapsed comments +section]({static}/images/elegant-theme_comments-section-collapsed.png) + +It expands when reader clicks on it + +![Uncollapsed comments +section]({static}/images/elegant-theme_comments-section-uncollapsed.png) diff --git a/documentation/content/Elegant - Pelican Theme/elegant-theme.md b/documentation/content/Elegant - Pelican Theme/elegant-theme.md index 3043edf0..531cc344 100644 --- a/documentation/content/Elegant - Pelican Theme/elegant-theme.md +++ b/documentation/content/Elegant - Pelican Theme/elegant-theme.md @@ -162,32 +162,6 @@ your configuration file. You can also define `EMAIL_SUBSCRIPTION_LABEL`, `EMAIL_FIELD_PLACEHOLDER` and `SUBSCRIBE_BUTTON_TITLE` to customize user experience. -## Collapsible Comments - -Readers use scroll bar to track their progress when reading inside their -browsers. Very often comments take up more space than the actual article. When -comments take up more space, it throws the scroll bar proportion off and reader -cannot judge his progress correctly. Hacker News hosted [a -discussion](https://news.ycombinator.com/item?id=6246777) on this topic. - -> tons of online articles list comments on the same page, so the scroll bar is -> almost a negative incentive to keep reading. "I've read this much of the -> article and I'm only 1/20th of the way down?" -> [user stops reading, unaware that there's 450 comments and the article is actually pretty short] - -Elegant keeps the comments section hidden by default. Reader can hide and -unhide the section by clicking on the comments section. - -This is how comments section appear - -![Collapsed comments -section]({static}/images/elegant-theme_comments-section-collapsed.png) - -It expands when reader clicks on it - -![Uncollapsed comments -section]({static}/images/elegant-theme_comments-section-uncollapsed.png) - ## Articles Count with every Tag and Category Readers of an article on your site usually look for other articles on the same From 2a77c8631964cc804dd5904c542d9374bc086f49 Mon Sep 17 00:00:00 2001 From: Talha Mansoor Date: Sun, 30 Jun 2019 23:20:15 +0500 Subject: [PATCH 10/52] docs(update): extract content into their own articles --- .../Appearance and Style/article-count.md | 27 +++++++ .../Appearance and Style/article-subtitle.md | 24 ++++++ .../Appearance and Style/page-title.md | 33 ++++++++ .../Elegant - Pelican Theme/elegant-theme.md | 75 ------------------- 4 files changed, 84 insertions(+), 75 deletions(-) create mode 100644 documentation/content/Appearance and Style/article-count.md create mode 100644 documentation/content/Appearance and Style/article-subtitle.md create mode 100644 documentation/content/Appearance and Style/page-title.md diff --git a/documentation/content/Appearance and Style/article-count.md b/documentation/content/Appearance and Style/article-count.md new file mode 100644 index 00000000..f53c2094 --- /dev/null +++ b/documentation/content/Appearance and Style/article-count.md @@ -0,0 +1,27 @@ +--- +Title: Articles Count With Every Tag & Category +Tags: nuances +layout: post +Date: 2013-08-27 23:20 +comments: false +Slug: articles-count-with-every-tag-and-category +Category: Appearance & Style +--- + +Readers of an article on your site usually look for other articles on the same +topic. Categories and tags are a way of showing them related articles. Elegant +displays the count of articles that you have written in a category or tag in a +non-intrusive manner. + +Every category and tag has the count of articles in superscript. So if you have +written three articles in the C++ category or tag, it will have 3 in the +superscript. This way visitor will know you have written other articles too on +the same topic. + +Check out the screenshots, + +![Count of articles in a category is displayed in +superscript]({static}/images/elegant-theme_category-superscript-count.png) + +![Count of articles that have been tagged is displayed in +superscript]({static}/images/elegant-theme_tag-superscript-count.png) diff --git a/documentation/content/Appearance and Style/article-subtitle.md b/documentation/content/Appearance and Style/article-subtitle.md new file mode 100644 index 00000000..71d309aa --- /dev/null +++ b/documentation/content/Appearance and Style/article-subtitle.md @@ -0,0 +1,24 @@ +--- +Title: Article Subtitle +Tags: nuances +layout: post +Date: 2013-08-27 23:20 +comments: false +Slug: article-subtitle +Category: Appearance & Style +--- + +Pelican lets you define title of your article in the meta data. Elegant adds +subtitle support. Just define `subtitle` in your article's meta data and it +will appear along with your title. Here is an example, + +![Article subtitle +example]({static}/images/elegant-theme_article-subtitle.png) + +Article subtitle is displayed with the title in every list. To keep it visibly +separate from title, subtitle is enclosed in `` tag. When visible cue +cannot be used, like in the title attribute of HTML anchor tag ``, a hyphen +is inserted between them. + +![Article title and subtitle separated with a +hyphen]({static}/images/elegant-theme_article-subtitle-hyphen.png) diff --git a/documentation/content/Appearance and Style/page-title.md b/documentation/content/Appearance and Style/page-title.md new file mode 100644 index 00000000..ce8e9eef --- /dev/null +++ b/documentation/content/Appearance and Style/page-title.md @@ -0,0 +1,33 @@ +--- +Title: Page Title +Tags: nuances +layout: post +Date: 2013-08-27 23:20 +comments: false +Slug: page-title +Category: Appearance & Style +--- + +Elegant follows following format for the `` tag + +``` +Article title · Site Name +``` + +![Article title is always visible in the +tab]({static}/images/elegant-theme_page-title.png) + +Some sites put site title first and article title later in the `<title>` tag. +There is a problem with this approach. When you open too many tabs, browser +delimits tab's title from the end. In such cases, only the first few words or +even letters of the `<title>` are left visible. + +If visitor has opened several tabs from your website, all tabs will have "Site +Name..." title. User will need to click on each tab to identify his required +tab from the content. But with Elegant's approach article title will always be +visible, and reader will have less difficultly in identifying the tab he is +after. + +Putting site title before the article title increases your site name +visibility. Elegant achieves this by putting site name in the top navigation +bar of every page, where it always stays above the fold. diff --git a/documentation/content/Elegant - Pelican Theme/elegant-theme.md b/documentation/content/Elegant - Pelican Theme/elegant-theme.md index 531cc344..744efb4a 100644 --- a/documentation/content/Elegant - Pelican Theme/elegant-theme.md +++ b/documentation/content/Elegant - Pelican Theme/elegant-theme.md @@ -162,87 +162,12 @@ your configuration file. You can also define `EMAIL_SUBSCRIPTION_LABEL`, `EMAIL_FIELD_PLACEHOLDER` and `SUBSCRIBE_BUTTON_TITLE` to customize user experience. -## Articles Count with every Tag and Category - -Readers of an article on your site usually look for other articles on the same -topic. Categories and tags are a way of showing them related articles. Elegant -displays the count of articles that you have written in a category or tag in a -non-intrusive manner. - -Every category and tag has the count of articles in superscript. So if you have -written three articles in the C++ category or tag, it will have 3 in the -superscript. This way visitor will know you have written other articles too on -the same topic. - -Check out the screenshots, - -![Count of articles in a category is displayed in -superscript]({static}/images/elegant-theme_category-superscript-count.png) - -![Count of articles that have been tagged is displayed in -superscript]({static}/images/elegant-theme_tag-superscript-count.png) - ## Custom 404 Page Elegant has a custom Error 404 page for your readers. ![Error 404 page]({static}/images/elegant-theme_error-404-page.png) -## Page Title - -Elegant follows following format for the `<title>` tag - -``` -Article title · Site Name -``` - -![Article title is always visible in the -tab]({static}/images/elegant-theme_page-title.png) - -Some sites put site title first and article title later in the `<title>` tag. -There is a problem with this approach. When you open too many tabs, browser -delimits tab's title from the end. In such cases, only the first few words or -even letters of the `<title>` are left visible. - -If visitor has opened several tabs from your website, all tabs will have "Site -Name..." title. User will need to click on each tab to identify his required -tab from the content. But with Elegant's approach article title will always be -visible, and reader will have less difficultly in identifying the tab he is -after. - -Putting site title before the article title increases your site name -visibility. Elegant achieves this by putting site name in the top navigation -bar of every page, where it always stays above the fold. - -## Code Style - -Elegant uses [Solarized](http://ethanschoonover.com/solarized) theme for syntax -highlighting. Line numbers have a different background color so that they -appear distinct from the code. Here is an example - - #!c - int sample_function (void) { - printf ("This is a sample function"); - return 0 - } - -## Article Subtitle - -Pelican lets you define title of your article in the meta data. Elegant adds -subtitle support. Just define `subtitle` in your article's meta data and it -will appear along with your title. Here is an example, - -![Article subtitle -example]({static}/images/elegant-theme_article-subtitle.png) - -Article subtitle is displayed with the title in every list. To keep it visibly -separate from title, subtitle is enclosed in `<small>` tag. When visible cue -cannot be used, like in the title attribute of HTML anchor tag `<a>`, a hyphen -is inserted between them. - -![Article title and subtitle separated with a -hyphen]({static}/images/elegant-theme_article-subtitle-hyphen.png) - --- ## Elegant - Technical Nitty-Gritty From 44fa36af380b7c2ec354a40d81d765302727b9fd Mon Sep 17 00:00:00 2001 From: Talha Mansoor <talha131@gmail.com> Date: Sun, 30 Jun 2019 23:28:43 +0500 Subject: [PATCH 11/52] docs(update): fix spelling --- documentation/content/Comments/invite-comments.md | 2 +- documentation/content/SEO and SMO/claim-site.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/content/Comments/invite-comments.md b/documentation/content/Comments/invite-comments.md index 3dd92814..399346bc 100644 --- a/documentation/content/Comments/invite-comments.md +++ b/documentation/content/Comments/invite-comments.md @@ -1,5 +1,5 @@ --- -Title: Invite Vistors To Comment +Title: Invite Visitors To Comment Tags: interaction layout: post Date: 2014-04-21 16:39 diff --git a/documentation/content/SEO and SMO/claim-site.md b/documentation/content/SEO and SMO/claim-site.md index 60701832..cbb267f2 100644 --- a/documentation/content/SEO and SMO/claim-site.md +++ b/documentation/content/SEO and SMO/claim-site.md @@ -6,7 +6,7 @@ Date: 2019-06-27 Slug: website-claim Disqus_identifier: hk9m5eq-website-claim Subtitle: -Summary: Use Elegain to insert headers to claim website +Summary: Easily insert headers to claim website Keywords: --- From 23e0b947704936c3bcd3684bec7ab99bdddff7bb Mon Sep 17 00:00:00 2001 From: Talha Mansoor <talha131@gmail.com> Date: Sun, 30 Jun 2019 23:51:13 +0500 Subject: [PATCH 12/52] feat(menu): set home URL to root if SITEURL is not This is useful when you are running site locally and have set SITEURL to empty string. --- templates/base.html | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/templates/base.html b/templates/base.html index 96d2be86..a60363b2 100644 --- a/templates/base.html +++ b/templates/base.html @@ -64,7 +64,15 @@ <a class="brand" href="{{ SITEURL }}/"><span class=site-name>{{ SITENAME }}</span></a> <div class="nav-collapse collapse"> <ul class="nav pull-right top-menu"> - <li {% if page_name == 'index' %} class="active"{% endif %}><a href="{{ SITEURL }}">Home</a></li> + <li {% if page_name == 'index' %} class="active"{% endif %}> + <a href= + {% if SITEURL %} + {{ SITEURL }} + {% else %} + "/" + {% endif %} + >Home</a> + </li> {% if DISPLAY_PAGES_ON_MENU %} {% for p in pages %} <li {% if p == page %} class="active"{% endif %}><a href="{{ SITEURL }}/{{ p.url }}">{{ p.title }}</a></li> From 9b5b2eca2a34a5d9898173a8118cb5e37621dfd5 Mon Sep 17 00:00:00 2001 From: Talha Mansoor <talha131@gmail.com> Date: Mon, 1 Jul 2019 00:52:19 +0500 Subject: [PATCH 13/52] feat(home): write about me in markdown, reST or asciidoc BREAKING CHANGE: Previously LANDING_PAGE_ABOUT was a dictionary that contained html tags. We used it to create landing page. But users have demanded from the very beginning to be able to write the landing page in markdown. This patch adds this feature. But in order to use it, you have to update your configuration. fix #85 --- templates/_includes/_defaults.html | 13 ++++------- templates/index.html | 36 ++++++++++++++++++------------ 2 files changed, 26 insertions(+), 23 deletions(-) diff --git a/templates/_includes/_defaults.html b/templates/_includes/_defaults.html index 4518932a..740a1ef5 100644 --- a/templates/_includes/_defaults.html +++ b/templates/_includes/_defaults.html @@ -119,17 +119,12 @@ {% set USE_SHORTCUT_ICONS = USE_SHORTCUT_ICONS %} {% endif %} -{# It is a dictionary with two keys: title, details. Value of each key is a -string. It is used to display About me section on the home page. -LANDING_PAGE_ABOUT = {'title': 'Talha Mansoor', - 'details': '<p>I am a software developer. This blog is' - 'my personal space in the cyber world!</p>' - } +{# It is a string #} -{% if not LANDING_PAGE_ABOUT %} -{% set LANDING_PAGE_ABOUT = '' %} +{% if not LANDING_PAGE_TITLE %} +{% set LANDING_PAGE_TITLE = '' %} {% else %} -{% set LANDING_PAGE_ABOUT = LANDING_PAGE_ABOUT %} +{% set LANDING_PAGE_TITLE = LANDING_PAGE_TITLE %} {% endif %} {# It is an array of dictionaries. Each dictionary has three keys: name, url, diff --git a/templates/index.html b/templates/index.html index e423cf56..a71ee001 100644 --- a/templates/index.html +++ b/templates/index.html @@ -6,10 +6,10 @@ {% block meta_tags_in_head %} {{ super() }} -{% from '_includes/_defaults.html' import LANDING_PAGE_ABOUT with context %} -{% if LANDING_PAGE_ABOUT and LANDING_PAGE_ABOUT.title %} -<meta property="og:title" content="{{ LANDING_PAGE_ABOUT.title|e }}"/> -<meta name="twitter:title" content="{{ LANDING_PAGE_ABOUT.title|e }}"> +{% from '_includes/_defaults.html' import LANDING_PAGE_TITLE with context %} +{% if LANDING_PAGE_TITLE %} +<meta property="og:title" content="{{ LANDING_PAGE_TITLE|e }}"/> +<meta name="twitter:title" content="{{ LANDING_PAGE_TITLE|e }}"> {% else %} <meta property="og:title" content="{{ SITENAME|striptags|e }}"/> <meta name="twitter:title" content="{{ SITENAME|striptags|e }}"> @@ -30,39 +30,47 @@ {% endblock meta_tags_in_head %} {% block content %} -{% from '_includes/_defaults.html' import LANDING_PAGE_ABOUT with context %} +{% from '_includes/_defaults.html' import LANDING_PAGE_TITLE with context %} {% from '_includes/_defaults.html' import PROJECTS with context %} {% from '_includes/_defaults.html' import PROJECTS_TITLE with context %} + +{% set landing_page = namespace(page=false) %} +{% for p in hidden_pages if p.slug == "landing-page-about-hidden" %} +{% set landing_page.page = p %} +{% endfor %} + +{{landing_page.page.title}} + <div class="row-fluid"> - {% if LANDING_PAGE_ABOUT and LANDING_PAGE_ABOUT.title %} + {% if LANDING_PAGE_TITLE %} {% set css_class = 'span10 offset2' %} - {% if PROJECTS and LANDING_PAGE_ABOUT %} + {% if PROJECTS and LANDING_PAGE_TITLE %} {% set css_class = 'span12' %} {% endif %} <header class="page-header {{css_class}}"> - <h1><a href="{{ SITEURL }}">{{ LANDING_PAGE_ABOUT.title }}</a></h1> + <h1><a href="{{ SITEURL }}">{{ LANDING_PAGE_TITLE }}</a></h1> </header> {% endif %} <div class="row-fluid"> - {% if LANDING_PAGE_ABOUT and LANDING_PAGE_ABOUT.details %} + {% if LANDING_PAGE_TITLE and landing_page.page %} {% set css_class = 'span8 offset2' %} - {% if PROJECTS and LANDING_PAGE_ABOUT %} + {% if PROJECTS and LANDING_PAGE_TITLE %} {% set css_class = 'span8' %} {% endif %} <div class="{{css_class}}"> <header> - <h1 id="about-me">About me</h1> + <h1 id="about-me">{{landing_page.page.title}}</h1> </header> <div class="article-content"> - {{ LANDING_PAGE_ABOUT.details }} + {{ landing_page.page.content }} </div> </div> {% endif %} {% if PROJECTS %} {% set css_class = 'span8 offset2' %} - {% if PROJECTS and LANDING_PAGE_ABOUT %} + {% if PROJECTS and LANDING_PAGE_TITLE %} {% set css_class = 'span4' %} {% endif %} <div class="{{css_class}}"> @@ -82,7 +90,7 @@ <h1 id="my-projects">{{ PROJECTS_TITLE }}</h1> {% if articles %} {% set css_class = 'span8 offset2' %} - {% if articles and PROJECTS and LANDING_PAGE_ABOUT %} + {% if articles and PROJECTS and LANDING_PAGE_TITLE %} {% set css_class = 'span12' %} {% endif %} <div class="row-fluid"> From 610d8700663d2235e73ce71f12e8f0d606ec9d42 Mon Sep 17 00:00:00 2001 From: Talha Mansoor <talha131@gmail.com> Date: Mon, 1 Jul 2019 01:15:33 +0500 Subject: [PATCH 14/52] docs(add): add landing page --- .../Elegant - Pelican Theme/elegant-theme.md | 12 --------- .../content/pages/landing-page-about-me.md | 27 +++++++++++++++++++ documentation/pelicanconf.py | 7 +---- documentation/publishconf.py | 2 +- 4 files changed, 29 insertions(+), 19 deletions(-) create mode 100644 documentation/content/pages/landing-page-about-me.md diff --git a/documentation/content/Elegant - Pelican Theme/elegant-theme.md b/documentation/content/Elegant - Pelican Theme/elegant-theme.md index 744efb4a..077e80cb 100644 --- a/documentation/content/Elegant - Pelican Theme/elegant-theme.md +++ b/documentation/content/Elegant - Pelican Theme/elegant-theme.md @@ -11,18 +11,6 @@ keywords: pelican theme, responsive theme, tipue search [TOC] -Elegant is a stylish, responsive, and minimal [Pelican](http://getpelican.com/) -theme that looks amazing across all screen resolutions and devices. - -Elegant gives meaning to the expression "sand the under side of the drawer." -Every feature and style of Elegant is the result of a long thought process. - -<div style="text-align:center;"> -<a class="btn btn-large btn-primary" onClick="_gaq.push(['_trackEvent', 'Outbound Link', 'Download on Github']);" href="https://github.com/Pelican-Elegant/elegant/archive/V1.3.zip" target="_blank">Get Elegant <small>1.3</small></a> -<div><a href="#license" title="License Agreement for using Elegant Theme"><small>License Agreement</small></a>|<a href="https://github.com/Pelican-Elegant/elegant/blob/master/RELEASE_NOTES.md#version-13" title="Release notes for Version 1.3" target="_blank"><small>Release Notes</small></a></div> -<div><p><a onClick="_gaq.push(['_trackEvent', 'Outbound Link', 'Leave a Tip']);" href="http://gittip.com/talha131" target="_blank" style="color:#8B0000"> <i class="fa fa-gittip"></i> Show your support. Leave a tip! <i class="fa fa-gittip"></i></a></p></div> -</div> - What makes Elegant so special? ## Search diff --git a/documentation/content/pages/landing-page-about-me.md b/documentation/content/pages/landing-page-about-me.md new file mode 100644 index 00000000..979fa28f --- /dev/null +++ b/documentation/content/pages/landing-page-about-me.md @@ -0,0 +1,27 @@ +--- +author: Talha Mansoor +title: What Is Elegant +layout: page +date: 2019-01-14 7:30:47 +0100 +status: hidden +slug: landing-page-about-hidden +--- + +Elegant is a stylish, responsive, and minimal Pelican +theme that looks amazing across all screen resolutions and devices. + +Elegant gives meaning to the expression **"sand the under side of the drawer"**. +Every feature and style of Elegant is the result of a long thought process. + +## What Makes Elegant So Special? + +Elegant is the only Pelican theme that search, live filter tags, zero clutter categories, lazy load comments, Mailchimp, FreeLists support and a cutomizable landing page. +That's not all. Go through our documentation, you will find several unique features and nuances that you will not find in any other theme. + +To top it of, it is the only theme with comprehensive documentation and an automated build, deploy and release process. + +## Try It Out + +This site is a demonstration and documentation of Elegant theme. + +To try out Elegant, you don't need to install anything. Just visit different pages of this site. Try the search function. Check out our categories. What you see here is what you get. diff --git a/documentation/pelicanconf.py b/documentation/pelicanconf.py index 7dfedc6a..7eda92f2 100644 --- a/documentation/pelicanconf.py +++ b/documentation/pelicanconf.py @@ -137,9 +137,4 @@ }, ] -LANDING_PAGE_ABOUT = { - "title": "Elegant – Why it is the Best Pelican Theme", - "details": """<p>This page serves both as documentation site and demonstration of Pelican-Elegant theme - capabilities and look&feel.</p><p>Please do check our Project pages and browse this site for more information. - </p>""", -} +LANDING_PAGE_TITLE ="Elegant – Why it is the Best Pelican Theme" diff --git a/documentation/publishconf.py b/documentation/publishconf.py index f141ccdd..d703cd88 100644 --- a/documentation/publishconf.py +++ b/documentation/publishconf.py @@ -28,7 +28,7 @@ SITENAME = "Elegant (Next)" SITESUBTITLE = "Pre Release Documentation of The Best Pelican Theme" SITEURL = "https://next.elegant.oncrashreboot.com" - LANDING_PAGE_ABOUT["title"] = "Elegant (Next) – Why it is the Best Pelican Theme" + LANDING_PAGE_TITLE = "Elegant (Next) – Why it is the Best Pelican Theme" if os.environ.get("STAT_COUNTER_PROJECT_NEXT") and os.environ.get( "STAT_COUNTER_SECURITY_NEXT" ): From 2e581acb683e9fc19d3909d0fd262c9b9b64905a Mon Sep 17 00:00:00 2001 From: Talha Mansoor <talha131@gmail.com> Date: Mon, 1 Jul 2019 01:16:13 +0500 Subject: [PATCH 15/52] chore(docs): enable nl2br markdown extension --- documentation/pelicanconf.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/documentation/pelicanconf.py b/documentation/pelicanconf.py index 7eda92f2..030205f8 100644 --- a/documentation/pelicanconf.py +++ b/documentation/pelicanconf.py @@ -22,6 +22,7 @@ "markdown.extensions.codehilite": {"css_class": "highlight"}, "markdown.extensions.extra": {}, "markdown.extensions.meta": {}, + "markdown.extensions.nl2br": {}, "markdown.extensions.toc": {"permalink": "true"}, } } @@ -137,4 +138,4 @@ }, ] -LANDING_PAGE_TITLE ="Elegant – Why it is the Best Pelican Theme" +LANDING_PAGE_TITLE = "Elegant – Why it is the Best Pelican Theme" From 57446da86d77672377f5564e38422a8a64e0a877 Mon Sep 17 00:00:00 2001 From: Talha Mansoor <talha131@gmail.com> Date: Mon, 1 Jul 2019 01:41:50 +0500 Subject: [PATCH 16/52] docs(add): document landing page features --- .../Building Readership/landing-page.md | 92 +++++++++++++++++++ .../configuration-variables.md | 3 - .../Elegant - Pelican Theme/elegant-theme.md | 49 ---------- 3 files changed, 92 insertions(+), 52 deletions(-) create mode 100644 documentation/content/Building Readership/landing-page.md diff --git a/documentation/content/Building Readership/landing-page.md b/documentation/content/Building Readership/landing-page.md new file mode 100644 index 00000000..2420a177 --- /dev/null +++ b/documentation/content/Building Readership/landing-page.md @@ -0,0 +1,92 @@ +--- +Title: Customize Home Page +Tags: nuances, remarkable, unique +layout: post +Date: 2019-07-01 01:22 +comments: false +Slug: customize-home-page +Category: Building Readership +--- + +This is the page that visitors see when they open your website. Your chance to +make a good and lasting first impression. Most sites just display a list of +recent posts. Elegant goes the extra mile. Check this out + +![Home Page Sample]({static}/images/elegant-theme_home-page-features.png) + +You can see two sections here, + +1. About me +1. My Projects + +There is a third section below these two sections, "Recent articles" + +![Recent Articles Section]({static}/images/elegant-theme_recent-posts.png) + +## Welcome Heading + +Define `LANDING_PAGE_TITLE` in your Pelican configuration. It will be displayed as the welcome heading. For example, + +```python +LANDING_PAGE_TITLE = "Elegant – Why it is the Best Pelican Theme" +``` + +## About Me + +To write about me section, create a page. See [Pelican documentation](http://docs.getpelican.com/en/stable/content.html#pages) on how to create a page. + +The slug of the page should be `landing-page-about-hidden` and `status` should be `hidden`. Example, + +```yaml +--- +author: Talha Mansoor +title: What Is Elegant +layout: page +date: 2019-01-14 7:30:47 +0100 +status: hidden +slug: landing-page-about-hidden +--- + +``` + +The content of this will become your "About me" section, and title will become the heading. You can write content in any markup language, like Markdown, AsciiDoc or reST, as long as Pelican has supports it. + +### Deprecated + +!!! Danger "Warning: Legacy Variable" + + `LANDING_PAGE_ABOUT` was available in Elegant V2.5.0. It has since been passed out in favour of `landing-page-about-hidden`. The new method lets you write "About Me" in your favourite markup language. + +You can write up your own About me section using `LANDING_PAGE_ABOUT` variable +in your configuration. It is a dictionary that has two keys `title` and +`details`. + +Value of `title` is displayed in the header of the home page, like +in the above example it is "I design and build software products for iOS and +OSX". + +`details` is the text that appears under "About me" heading. You can add raw HTML to it. + +## Projects + +Projects list is read from `PROJECTS`. It is an array of dictionaries. Each +dictionary has three keys, `name` which will have name of your project, `url` +which will have URL of the project, and `description` which will have the +description of the project. You can define as many projects as you want. Here +is an example, + + #!Python + PROJECTS = [{ + 'name': 'Logpad + Duration', + 'url': 'https://github.com/talha131/logpad-plus-duration#logpad--duration', + 'description': 'Vim plugin to emulate Windows Notepad logging feature,' + ' and log duration of each entry'}, + {'name': 'Elegant Theme for Pelican', + 'url': 'http://oncrashreboot.com/pelican-elegant', + 'description': 'A clean and distraction free theme, with search and a' + ' lot more unique features, using Jinja2 and Bootstrap'}] + +### Recent Articles + +Recent articles show last `RECENT_ARTICLES_COUNT` whose default value is 10. It +also has a link to "all posts". diff --git a/documentation/content/Elegant - Pelican Theme/configuration-variables.md b/documentation/content/Elegant - Pelican Theme/configuration-variables.md index 47fb81a0..03796259 100644 --- a/documentation/content/Elegant - Pelican Theme/configuration-variables.md +++ b/documentation/content/Elegant - Pelican Theme/configuration-variables.md @@ -43,9 +43,6 @@ These are the optional configuration variables that you can define [comments](how-to-use-disqus-comments-elegantly#invite-visitors-to-comment) 1. `SITE_DESCRIPTION` used for [Search Engine Optimization](search-engine-and-social-media-optimization#search-engine-optimization-seo) -1. `LANDING_PAGE_ABOUT` used for [About me - feature](elegant-best-pelican-theme-features#about-me) - on the landing page 1. `SOCIAL_PROFILE_LABEL` used with [social media profiles widget](how-to-display-your-social-media-profiles) 1. `RECENT_ARTICLES_COUNT` see the post [Recent diff --git a/documentation/content/Elegant - Pelican Theme/elegant-theme.md b/documentation/content/Elegant - Pelican Theme/elegant-theme.md index 077e80cb..3363cc18 100644 --- a/documentation/content/Elegant - Pelican Theme/elegant-theme.md +++ b/documentation/content/Elegant - Pelican Theme/elegant-theme.md @@ -87,55 +87,6 @@ uncollapsed]({static}/images/elegant-theme_category-accordions-uncollapsed.png) Did you notice that categories are listed in ascending alphabetical order and articles are sorted by their date in descending order? -## Home Page Features - -This is the page that visitors see when they open your website. Your chance to -make a good and lasting first impression. Most sites just display a list of -recent posts. Elegant goes the extra mile. Check this out - -![Home Page Sample]({static}/images/elegant-theme_home-page-features.png) - -You can see two sections here, - -1. About me -1. My Projects - -There is a third section below these two sections, "Recent articles" - -![Recent Articles Section]({static}/images/elegant-theme_recent-posts.png) - -### About me - -You can write up your own About me section using `LANDING_PAGE_ABOUT` variable -in your configuration. It is a dictionary that has two keys `title` and -`details`. Value of `title` is displayed in the header of the home page, like -in the above example it is "I design and build software products for iOS and -OSX". `details` is the text that appears under "About me" heading. - -### Projects - -Projects list is read from `PROJECTS`. It is an array of dictionaries. Each -dictionary has three keys, `name` which will have name of your project, `url` -which will have URL of the project, and `description` which will have the -description of the project. You can define as many projects as you want. Here -is an example, - - #!Python - PROJECTS = [{ - 'name': 'Logpad + Duration', - 'url': 'https://github.com/talha131/logpad-plus-duration#logpad--duration', - 'description': 'Vim plugin to emulate Windows Notepad logging feature,' - ' and log duration of each entry'}, - {'name': 'Elegant Theme for Pelican', - 'url': 'http://oncrashreboot.com/pelican-elegant', - 'description': 'A clean and distraction free theme, with search and a' - ' lot more unique features, using Jinja2 and Bootstrap'}] - -### Recent Articles - -Recent articles show last `RECENT_ARTICLES_COUNT` whose default value is 10. It -also has a link to "all posts". - ## Mailchimp Mailchimp has become the preferred newsletter service. Elegant shows a form to From 2dc5aa64c4e2484dfce6f18877ed164cd58d508a Mon Sep 17 00:00:00 2001 From: Talha Mansoor <talha131@gmail.com> Date: Mon, 1 Jul 2019 01:45:54 +0500 Subject: [PATCH 17/52] docs(add): document PROJECTS_TITLE feature --- .../content/Building Readership/landing-page.md | 16 +++++++++++++--- .../configuration-variables.md | 1 - 2 files changed, 13 insertions(+), 4 deletions(-) diff --git a/documentation/content/Building Readership/landing-page.md b/documentation/content/Building Readership/landing-page.md index 2420a177..4699242c 100644 --- a/documentation/content/Building Readership/landing-page.md +++ b/documentation/content/Building Readership/landing-page.md @@ -70,9 +70,13 @@ OSX". ## Projects Projects list is read from `PROJECTS`. It is an array of dictionaries. Each -dictionary has three keys, `name` which will have name of your project, `url` -which will have URL of the project, and `description` which will have the -description of the project. You can define as many projects as you want. Here +dictionary has three keys, + +1. `name` which will have name of your project, +1. `url` which will have URL of the project, and +1. `description` which will have the description of the project. + +You can define as many projects as you want. Here is an example, #!Python @@ -86,6 +90,12 @@ is an example, 'description': 'A clean and distraction free theme, with search and a' ' lot more unique features, using Jinja2 and Bootstrap'}] +To configure the projects' list title, set `PROJECTS_TITLE` variable in your Pelican configuration. Its default value is "My Projects". For example, + +```python +PROJECTS_TITLE = "Related Projects" +``` + ### Recent Articles Recent articles show last `RECENT_ARTICLES_COUNT` whose default value is 10. It diff --git a/documentation/content/Elegant - Pelican Theme/configuration-variables.md b/documentation/content/Elegant - Pelican Theme/configuration-variables.md index 03796259..cb111f7e 100644 --- a/documentation/content/Elegant - Pelican Theme/configuration-variables.md +++ b/documentation/content/Elegant - Pelican Theme/configuration-variables.md @@ -32,7 +32,6 @@ These are the optional configuration variables that you can define 1. `PROJECTS` used for [Projects feature](elegant-best-pelican-theme-features#projects) on the landing page -1. `PROJECTS_TITLE` used for changing title of `PROJECTS` list 1. `USE_SHORTCUT_ICONS` used for [shortcut icons like favicon, Opera Speed Dial](how-to-set-shortcut-icons) 1. `SITE_LICENSE` used to add [site From 1ae7fc43776b79f6a21cf1f38a7eb06c36919a26 Mon Sep 17 00:00:00 2001 From: Talha Mansoor <talha131@gmail.com> Date: Mon, 1 Jul 2019 01:47:17 +0500 Subject: [PATCH 18/52] docs(update): fix spelling --- documentation/content/pages/landing-page-about-me.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/content/pages/landing-page-about-me.md b/documentation/content/pages/landing-page-about-me.md index 979fa28f..a5293375 100644 --- a/documentation/content/pages/landing-page-about-me.md +++ b/documentation/content/pages/landing-page-about-me.md @@ -15,7 +15,7 @@ Every feature and style of Elegant is the result of a long thought process. ## What Makes Elegant So Special? -Elegant is the only Pelican theme that search, live filter tags, zero clutter categories, lazy load comments, Mailchimp, FreeLists support and a cutomizable landing page. +Elegant is the only Pelican theme that search, live filter tags, zero clutter categories, lazy load comments, Mailchimp, FreeLists support and a customizable landing page. That's not all. Go through our documentation, you will find several unique features and nuances that you will not find in any other theme. To top it of, it is the only theme with comprehensive documentation and an automated build, deploy and release process. From bf7817f3a6665117e80eb2f9868d6e4029338f97 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pablo=20Iranzo=20G=C3=B3mez?= <Pablo.Iranzo@gmail.com> Date: Sun, 30 Jun 2019 17:18:06 +0200 Subject: [PATCH 19/52] ci(hound): remove hound support MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Pablo Iranzo Gómez <Pablo.Iranzo@gmail.com> --- .hound.yml | 20 - .hound/eslintrc.json | 451 ----------------- .hound/ignoredfiles | 2 - .hound/rubocop.yml | 1038 --------------------------------------- .hound/stylelintrc.json | 50 -- .hound/tslint.json | 115 ----- 6 files changed, 1676 deletions(-) delete mode 100644 .hound.yml delete mode 100644 .hound/eslintrc.json delete mode 100644 .hound/ignoredfiles delete mode 100644 .hound/rubocop.yml delete mode 100644 .hound/stylelintrc.json delete mode 100644 .hound/tslint.json diff --git a/.hound.yml b/.hound.yml deleted file mode 100644 index 06e84697..00000000 --- a/.hound.yml +++ /dev/null @@ -1,20 +0,0 @@ -fail_on_violations: true -javascript: - enabled: true - ignore_file: .hound/ignoredfiles -eslint: - enabled: true - config_file: .hound/eslintrc.json - ignore_file: .hound/ignoredfiles -tslint: - enabled: true - config_file: .hound/tslint.json - ignore_file: .hound/ignoredfiles -ruby: - enabled: true - config_file: .hound/rubocop.yml - ignore_file: .hound/ignoredfiles -scss: - enabled: true - config_file: .hound/scss-lint.yml - ignore_file: .hound/ignoredfiles diff --git a/.hound/eslintrc.json b/.hound/eslintrc.json deleted file mode 100644 index a6bf5198..00000000 --- a/.hound/eslintrc.json +++ /dev/null @@ -1,451 +0,0 @@ -{ - "env": { - "es6": true - }, - "parserOptions": { - "ecmaVersion": 6, - "sourceType": "module" - }, - "plugins": ["import"], - "settings": { - "import/resolver": { - "node": { - "extensions": [".js", ".json"] - } - } - }, - "rules": { - "accessor-pairs": 0, - "array-callback-return": 2, - "block-scoped-var": 2, - "complexity": [ - 1, - { - "max": 20 - } - ], - "consistent-return": 2, - "curly": [2, "multi-line"], - "default-case": [ - 2, - { - "commentPattern": "^no default$" - } - ], - "dot-notation": [ - 1, - { - "allowKeywords": true - } - ], - "dot-location": [2, "property"], - "eqeqeq": [2], - "guard-for-in": 2, - "no-alert": 1, - "no-case-declarations": 2, - "no-div-regex": 0, - "no-else-return": 2, - "no-empty-function": [ - 2, - { - "allow": ["arrowFunctions", "functions", "methods"] - } - ], - "no-empty-pattern": 2, - "no-eval": 2, - "no-extend-native": 2, - "no-extra-bind": 2, - "no-fallthrough": 2, - "no-floating-decimal": 2, - "no-implicit-coercion": 0, - "no-implicit-globals": 2, - "no-implied-eval": 2, - "no-invalid-this": 0, - "no-iterator": 2, - "no-extra-label": 2, - "no-labels": [ - 2, - { - "allowLoop": false, - "allowSwitch": false - } - ], - "no-lone-blocks": 2, - "no-loop-func": 2, - "no-magic-numbers": [ - 2, - { - "ignore": [0, 1] - } - ], - "no-multi-spaces": 2, - "no-multi-str": 2, - "no-native-reassign": 2, - "no-new": 2, - "no-new-func": 2, - "no-new-wrappers": 2, - "no-octal": 2, - "no-octal-escape": 2, - "no-param-reassign": [ - 2, - { - "props": false - } - ], - "no-proto": 2, - "no-redeclare": 2, - "no-return-assign": 2, - "no-script-url": 2, - "no-self-assign": 2, - "no-self-compare": 2, - "no-sequences": 2, - "no-throw-literal": 2, - "no-unmodified-loop-condition": 0, - "no-unused-expressions": 2, - "no-unused-labels": 2, - "no-useless-call": 0, - "no-useless-concat": 2, - "no-useless-escape": 2, - "no-void": 0, - "no-warning-comments": [ - 1, - { - "terms": ["todo", "fixme", "xxx"], - "location": "start" - } - ], - "no-with": 2, - "radix": 2, - "vars-on-top": 2, - "wrap-iife": [2, "any"], - "yoda": 2, - "comma-dangle": [2, "always-multiline"], - "no-cond-assign": [2, "always"], - "no-console": 0, - "no-debugger": 0, - "no-constant-condition": 2, - "no-control-regex": 2, - "no-dupe-args": 2, - "no-dupe-keys": 2, - "no-duplicate-case": 2, - "no-empty": 2, - "no-empty-character-class": 2, - "no-ex-assign": 2, - "no-extra-boolean-cast": 0, - "no-extra-parens": [ - 0, - "all", - { - "conditionalAssign": true, - "nestedBinaryExpressions": false, - "returnAssign": false - } - ], - "no-extra-semi": 2, - "no-func-assign": 2, - "no-inner-declarations": 2, - "no-invalid-regexp": 2, - "no-irregular-whitespace": 2, - "no-negated-in-lhs": 2, - "no-obj-calls": 2, - "no-regex-spaces": 2, - "no-sparse-arrays": 2, - "no-unexpected-multiline": 0, - "no-unreachable": 2, - "no-unsafe-finally": 2, - "use-isnan": 2, - "valid-jsdoc": 0, - "valid-typeof": 2, - "arrow-body-style": [2, "as-needed"], - "arrow-parens": 0, - "arrow-spacing": [ - 2, - { - "before": true, - "after": true - } - ], - "constructor-super": 0, - "generator-star-spacing": [ - 2, - { - "before": true, - "after": false - } - ], - "no-class-assign": 2, - "no-confusing-arrow": [ - 2, - { - "allowParens": true - } - ], - "no-const-assign": 2, - "no-dupe-class-members": 2, - "no-duplicate-imports": 2, - "no-new-symbol": 2, - "no-restricted-imports": 0, - "no-this-before-super": 0, - "no-useless-computed-key": 2, - "no-useless-constructor": 2, - "no-var": 2, - "object-shorthand": [ - 2, - "always", - { - "ignoreConstructors": false, - "avoidQuotes": true - } - ], - "prefer-arrow-callback": [ - 2, - { - "allowNamedFunctions": false, - "allowUnboundThis": true - } - ], - "prefer-const": [ - 2, - { - "destructuring": "any", - "ignoreReadBeforeAssign": true - } - ], - "prefer-reflect": 0, - "no-caller": 2, - "prefer-rest-params": 2, - "prefer-spread": 2, - "prefer-template": 2, - "require-yield": 2, - "sort-imports": 0, - "template-curly-spacing": 2, - "yield-star-spacing": [2, "before"], - "import/no-unresolved": [0], - "import/named": 0, - "import/default": 0, - "import/namespace": 0, - "import/export": 2, - "import/no-named-as-default": 0, - "import/no-named-as-default-member": 0, - "import/no-deprecated": 0, - "import/no-extraneous-dependencies": [ - 0, - { - "devDependencies": false, - "optionalDependencies": false - } - ], - "import/no-mutable-exports": 2, - "import/no-commonjs": 0, - "import/no-amd": 2, - "import/no-nodejs-modules": 0, - "import/imports-first": [2, "absolute-first"], - "import/no-duplicates": 2, - "import/no-namespace": 0, - "import/extensions": [0, "never"], - "import/order": [ - 0, - { - "groups": [ - "builtin", - "external", - "internal", - "parent", - "sibling", - "index" - ], - "newlines-between": "never" - } - ], - "import/newline-after-import": 2, - "import/prefer-default-export": 2, - "array-bracket-spacing": [2, "never"], - "block-spacing": [2, "always"], - "brace-style": [ - 2, - "1tbs", - { - "allowSingleLine": true - } - ], - "camelcase": [ - 2, - { - "properties": "always" - } - ], - "comma-spacing": [ - 2, - { - "before": false, - "after": true - } - ], - "comma-style": [2, "last"], - "computed-property-spacing": [2, "never"], - "consistent-this": [2, "self"], - "eol-last": 2, - "func-names": 0, - "func-style": [2, "declaration"], - "id-blacklist": 0, - "id-length": 0, - "id-match": 0, - "indent": [2, 2], - "key-spacing": [ - 2, - { - "beforeColon": false, - "afterColon": true - } - ], - "keyword-spacing": [ - 2, - { - "before": true, - "after": true, - "overrides": { - "return": { - "after": true - }, - "throw": { - "after": true - }, - "case": { - "after": true - } - } - } - ], - "linebreak-style": [2, "unix"], - "lines-around-comment": 0, - "max-depth": [2, 4], - "max-len": [0], - "max-nested-callbacks": [2, 4], - "max-params": [1, 4], - "max-statements": [1, 10], - "max-statements-per-line": [ - 2, - { - "max": 1 - } - ], - "new-cap": [ - 2, - { - "newIsCap": true - } - ], - "new-parens": 2, - "newline-after-var": 0, - "newline-before-return": 2, - "newline-per-chained-call": [ - 2, - { - "ignoreChainWithDepth": 3 - } - ], - "no-array-constructor": 2, - "no-bitwise": 1, - "no-continue": 0, - "no-inline-comments": 0, - "no-lonely-if": 0, - "no-mixed-spaces-and-tabs": 2, - "no-multiple-empty-lines": [ - 2, - { - "max": 1, - "maxEOF": 1 - } - ], - "no-negated-condition": 2, - "no-nested-ternary": 2, - "no-new-object": 2, - "no-plusplus": 0, - "no-restricted-syntax": [ - 2, - "DebuggerStatement", - "ForInStatement", - "LabeledStatement", - "WithStatement" - ], - "no-spaced-func": 2, - "no-ternary": 0, - "no-trailing-spaces": 2, - "no-underscore-dangle": [1], - "no-unneeded-ternary": [ - 2, - { - "defaultAssignment": false - } - ], - "no-whitespace-before-property": 2, - "object-curly-spacing": [2, "always"], - "object-property-newline": [ - 0, - { - "allowMultiplePropertiesPerLine": true - } - ], - "one-var": [2, "never"], - "one-var-declaration-per-line": [2, "always"], - "operator-assignment": 2, - "operator-linebreak": [2, "after"], - "padded-blocks": [2, "never"], - "quote-props": [ - 2, - "as-needed", - { - "keywords": false, - "unnecessary": false, - "numbers": false - } - ], - "quotes": [ - 2, - "single", - { - "avoidEscape": true - } - ], - "require-jsdoc": 0, - "semi": [2, "always"], - "semi-spacing": [ - 2, - { - "before": false, - "after": true - } - ], - "sort-vars": 0, - "space-before-blocks": 2, - "space-before-function-paren": [ - 2, - { - "anonymous": "always", - "named": "never" - } - ], - "space-in-parens": [2, "never"], - "space-infix-ops": 2, - "space-unary-ops": 0, - "spaced-comment": [2], - "wrap-regex": 0, - "init-declarations": 0, - "no-catch-shadow": 2, - "no-delete-var": 0, - "no-label-var": 2, - "no-restricted-globals": 0, - "no-shadow": 2, - "no-shadow-restricted-names": 2, - "no-undef": 2, - "no-undef-init": 2, - "no-unused-vars": [ - 2, - { - "vars": "local", - "args": "after-used" - } - ], - "no-use-before-define": 2 - } -} diff --git a/.hound/ignoredfiles b/.hound/ignoredfiles deleted file mode 100644 index 9cac94e1..00000000 --- a/.hound/ignoredfiles +++ /dev/null @@ -1,2 +0,0 @@ -static/tipuesearch/ -static/magnific/ diff --git a/.hound/rubocop.yml b/.hound/rubocop.yml deleted file mode 100644 index a5e6f4fa..00000000 --- a/.hound/rubocop.yml +++ /dev/null @@ -1,1038 +0,0 @@ -AllCops: - Include: - - "**/*.rake" - - "**/Gemfile" - - "**/Rakefile" - Exclude: - - "vendor/**/*" - - "db/**/*" - - "bin/**/*" - DisplayCopNames: false - StyleGuideCopsOnly: false - TargetRubyVersion: 2.3 -Layout/AccessModifierIndentation: - Description: Check indentation of private/protected visibility modifiers. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#indent-public-private-protected - Enabled: true - EnforcedStyle: indent - SupportedStyles: - - outdent - - indent -Layout/AlignHash: - Description: Align the elements of a hash literal if they span more than one line. - Enabled: true - EnforcedHashRocketStyle: key - EnforcedColonStyle: key - EnforcedLastArgumentHashStyle: always_inspect - SupportedLastArgumentHashStyles: - - always_inspect - - always_ignore - - ignore_implicit - - ignore_explicit -Layout/AlignParameters: - Description: Align the parameters of a method call if they span more than one line. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-double-indent - Enabled: true - EnforcedStyle: with_fixed_indentation - SupportedStyles: - - with_first_parameter - - with_fixed_indentation -Style/AndOr: - Description: Use &&/|| instead of and/or. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-and-or-or - Enabled: true - EnforcedStyle: always - SupportedStyles: - - always - - conditionals -Style/BarePercentLiterals: - Description: Checks if usage of %() or %Q() matches configuration. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#percent-q-shorthand - Enabled: true - EnforcedStyle: bare_percent - SupportedStyles: - - percent_q - - bare_percent -Metrics/BlockLength: - Enabled: false -Style/BracesAroundHashParameters: - Description: Enforce braces style around hash parameters. - Enabled: true - EnforcedStyle: no_braces - SupportedStyles: - - braces - - no_braces - - context_dependent -Layout/CaseIndentation: - Description: Indentation of when in a case/when/[else/]end. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#indent-when-to-case - Enabled: true - EnforcedStyle: case - SupportedStyles: - - case - - end - IndentOneStep: false -Style/ClassAndModuleChildren: - Description: Checks style of children classes and modules. - Enabled: false - EnforcedStyle: nested - SupportedStyles: - - nested - - compact -Style/ClassCheck: - Description: Enforces consistent use of `Object#is_a?` or `Object#kind_of?`. - Enabled: true - EnforcedStyle: is_a? - SupportedStyles: - - is_a? - - kind_of? -Style/CollectionMethods: - Description: Preferred collection methods. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#map-find-select-reduce-size - Enabled: false - PreferredMethods: - collect: map - collect!: map! - inject: reduce - detect: find - find_all: select - find: detect -Style/CommentAnnotation: - Description: Checks formatting of special comments (TODO, FIXME, OPTIMIZE, HACK, - REVIEW). - StyleGuide: https://github.com/bbatsov/ruby-style-guide#annotate-keywords - Enabled: false - Keywords: - - TODO - - FIXME - - OPTIMIZE - - HACK - - REVIEW -Layout/DotPosition: - Description: Checks the position of the dot in multi-line method calls. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#consistent-multi-line-chains - Enabled: true - EnforcedStyle: leading - SupportedStyles: - - leading - - trailing -Layout/EmptyLineBetweenDefs: - Description: Use empty lines between defs. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#empty-lines-between-methods - Enabled: true - AllowAdjacentOneLineDefs: false -Layout/EmptyLinesAroundBlockBody: - Description: Keeps track of empty lines around block bodies. - Enabled: true - EnforcedStyle: no_empty_lines - SupportedStyles: - - empty_lines - - no_empty_lines -Layout/EmptyLinesAroundClassBody: - Description: Keeps track of empty lines around class bodies. - Enabled: true - EnforcedStyle: no_empty_lines - SupportedStyles: - - empty_lines - - no_empty_lines -Layout/EmptyLinesAroundModuleBody: - Description: Keeps track of empty lines around module bodies. - Enabled: true - EnforcedStyle: no_empty_lines - SupportedStyles: - - empty_lines - - no_empty_lines -Style/Encoding: - Description: Use UTF-8 as the source file encoding. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#utf-8 - Enabled: false - EnforcedStyle: always - SupportedStyles: - - when_needed - - always -Style/FileName: - Description: Use snake_case for source file names. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#snake-case-files - Enabled: false - Exclude: [] -Layout/FirstParameterIndentation: - Description: Checks the indentation of the first parameter in a method call. - Enabled: true - EnforcedStyle: special_for_inner_method_call_in_parentheses - SupportedStyles: - - consistent - - special_for_inner_method_call - - special_for_inner_method_call_in_parentheses -Style/For: - Description: Checks use of for or each in multiline loops. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-for-loops - Enabled: true - EnforcedStyle: each - SupportedStyles: - - for - - each -Style/FormatString: - Description: Enforce the use of Kernel#sprintf, Kernel#format or String#%. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#sprintf - Enabled: false - EnforcedStyle: format - SupportedStyles: - - format - - sprintf - - percent -Style/FrozenStringLiteralComment: - Enabled: false -Style/GlobalVars: - Description: Do not introduce global variables. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#instance-vars - Enabled: false - AllowedVariables: [] -Style/GuardClause: - Description: Check for conditionals that can be replaced with guard clauses - StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-nested-conditionals - Enabled: false - MinBodyLength: 1 -Style/HashSyntax: - Description: 'Prefer Ruby 1.9 hash syntax { a: 1, b: 2 } over 1.8 syntax { :a => - 1, :b => 2 }.' - StyleGuide: https://github.com/bbatsov/ruby-style-guide#hash-literals - Enabled: true - EnforcedStyle: ruby19 - SupportedStyles: - - ruby19 - - hash_rockets -Style/IfUnlessModifier: - Description: Favor modifier if/unless usage when you have a single-line body. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#if-as-a-modifier - Enabled: false - MaxLineLength: 80 -Layout/IndentationWidth: - Description: Use 2 spaces for indentation. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#spaces-indentation - Enabled: true - Width: 2 -Layout/IndentHash: - Description: Checks the indentation of the first key in a hash literal. - Enabled: true - EnforcedStyle: special_inside_parentheses - SupportedStyles: - - special_inside_parentheses - - consistent -Style/LambdaCall: - Description: Use lambda.call(...) instead of lambda.(...). - StyleGuide: https://github.com/bbatsov/ruby-style-guide#proc-call - Enabled: false - EnforcedStyle: call - SupportedStyles: - - call - - braces -Style/Next: - Description: Use `next` to skip iteration instead of a condition at the end. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-nested-conditionals - Enabled: false - EnforcedStyle: skip_modifier_ifs - MinBodyLength: 3 - SupportedStyles: - - skip_modifier_ifs - - always -Style/NonNilCheck: - Description: Checks for redundant nil checks. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-non-nil-checks - Enabled: true - IncludeSemanticChanges: false -Style/MethodDefParentheses: - Description: Checks if the method definitions have or don't have parentheses. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#method-parens - Enabled: true - EnforcedStyle: require_parentheses - SupportedStyles: - - require_parentheses - - require_no_parentheses -Style/MethodName: - Description: Use the configured style when naming methods. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#snake-case-symbols-methods-vars - Enabled: true - EnforcedStyle: snake_case - SupportedStyles: - - snake_case - - camelCase -Layout/MultilineOperationIndentation: - Description: Checks indentation of binary operations that span more than one line. - Enabled: true - EnforcedStyle: indented - SupportedStyles: - - aligned - - indented -Style/MutableConstant: - Description: Do not assign mutable objects to constants. - Enabled: false -Style/NumericLiterals: - Description: Add underscores to large numeric literals to improve their readability. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#underscores-in-numerics - Enabled: false - MinDigits: 5 -Style/ParenthesesAroundCondition: - Description: Don't use parentheses around the condition of an if/unless/while. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-parens-if - Enabled: true - AllowSafeAssignment: true -Style/PercentLiteralDelimiters: - Description: Use `%`-literal delimiters consistently - StyleGuide: https://github.com/bbatsov/ruby-style-guide#percent-literal-braces - Enabled: false - PreferredDelimiters: - "%": "()" - "%i": "()" - "%q": "()" - "%Q": "()" - "%r": "{}" - "%s": "()" - "%w": "()" - "%W": "()" - "%x": "()" -Style/PercentQLiterals: - Description: Checks if uses of %Q/%q match the configured preference. - Enabled: true - EnforcedStyle: lower_case_q - SupportedStyles: - - lower_case_q - - upper_case_q -Style/PredicateName: - Description: Check the names of predicate methods. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#bool-methods-qmark - Enabled: true - NamePrefix: - - is_ - - has_ - - have_ - NamePrefixBlacklist: - - is_ -Style/RaiseArgs: - Description: Checks the arguments passed to raise/fail. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#exception-class-messages - Enabled: false - EnforcedStyle: exploded - SupportedStyles: - - compact - - exploded -Style/RedundantReturn: - Description: Don't use return where it's not required. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-explicit-return - Enabled: true - AllowMultipleReturnValues: false -Style/Semicolon: - Description: Don't use semicolons to terminate expressions. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-semicolon - Enabled: true - AllowAsExpressionSeparator: false -Style/SignalException: - Description: Checks for proper usage of fail and raise. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#fail-method - Enabled: false - EnforcedStyle: semantic - SupportedStyles: - - only_raise - - only_fail - - semantic -Style/SingleLineBlockParams: - Description: Enforces the names of some block params. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#reduce-blocks - Enabled: false - Methods: - - reduce: - - a - - e - - inject: - - a - - e -Style/SingleLineMethods: - Description: Avoid single-line methods. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-single-line-methods - Enabled: false - AllowIfMethodIsEmpty: true -Style/StringLiterals: - Description: Checks if uses of quotes match the configured preference. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#consistent-string-literals - Enabled: false - EnforcedStyle: double_quotes - SupportedStyles: - - single_quotes - - double_quotes -Style/StringLiteralsInInterpolation: - Description: Checks if uses of quotes inside expressions in interpolated strings - match the configured preference. - Enabled: true - EnforcedStyle: single_quotes - SupportedStyles: - - single_quotes - - double_quotes -Layout/SpaceAroundBlockParameters: - Description: Checks the spacing inside and after block parameters pipes. - Enabled: true - EnforcedStyleInsidePipes: no_space - SupportedStylesInsidePipes: - - space - - no_space -Layout/SpaceAroundEqualsInParameterDefault: - Description: Checks that the equals signs in parameter default assignments have - or don't have surrounding space depending on configuration. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#spaces-around-equals - Enabled: true - EnforcedStyle: space - SupportedStyles: - - space - - no_space -Layout/SpaceBeforeBlockBraces: - Description: Checks that the left block brace has or doesn't have space before it. - Enabled: true - EnforcedStyle: space - SupportedStyles: - - space - - no_space -Layout/SpaceInsideBlockBraces: - Description: Checks that block braces have or don't have surrounding space. For - blocks taking parameters, checks that the left brace has or doesn't have trailing - space. - Enabled: true - EnforcedStyle: space - SupportedStyles: - - space - - no_space - EnforcedStyleForEmptyBraces: no_space - SpaceBeforeBlockParameters: true -Layout/SpaceInsideHashLiteralBraces: - Description: Use spaces inside hash literal braces - or don't. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#spaces-operators - Enabled: true - EnforcedStyle: space - EnforcedStyleForEmptyBraces: no_space - SupportedStyles: - - space - - no_space -Style/SymbolProc: - Description: Use symbols as procs instead of blocks when possible. - Enabled: true - IgnoredMethods: - - respond_to -Layout/TrailingBlankLines: - Description: Checks trailing blank lines and final newline. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#newline-eof - Enabled: true - EnforcedStyle: final_newline - SupportedStyles: - - final_newline - - final_blank_line -Style/TrailingCommaInArguments: - Description: Checks for trailing comma in argument lists. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas - Enabled: true -Style/TrailingCommaInLiteral: - Description: Checks for trailing comma in array and hash literals. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas - Enabled: true -Style/TrivialAccessors: - Description: Prefer attr_* methods to trivial readers/writers. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#attr_family - Enabled: false - ExactNameMatch: false - AllowPredicates: false - AllowDSLWriters: false - Whitelist: - - to_ary - - to_a - - to_c - - to_enum - - to_h - - to_hash - - to_i - - to_int - - to_io - - to_open - - to_path - - to_proc - - to_r - - to_regexp - - to_str - - to_s - - to_sym -Style/VariableName: - Description: Use the configured style when naming variables. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#snake-case-symbols-methods-vars - Enabled: true - EnforcedStyle: snake_case - SupportedStyles: - - snake_case - - camelCase -Style/WhileUntilModifier: - Description: Favor modifier while/until usage when you have a single-line body. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#while-as-a-modifier - Enabled: false - MaxLineLength: 80 -Style/WordArray: - Description: Use %w or %W for arrays of words. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#percent-w - Enabled: false - MinSize: 0 - WordRegex: !ruby/regexp /\A[\p{Word}]+\z/ -Metrics/AbcSize: - Description: A calculated magnitude based on number of assignments, branches, and - conditions. - Enabled: true - Max: 25 -Metrics/BlockNesting: - Description: Avoid excessive block nesting - StyleGuide: https://github.com/bbatsov/ruby-style-guide#three-is-the-number-thou-shalt-count - Enabled: true - Max: 3 -Metrics/ClassLength: - Description: Avoid classes longer than 100 lines of code. - Enabled: false - CountComments: false - Max: 100 -Metrics/CyclomaticComplexity: - Description: A complexity metric that is strongly correlated to the number of test - cases needed to validate a method. - Enabled: true - Max: 6 -Metrics/LineLength: - Description: Limit lines to 100 characters. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#100-character-limits - Enabled: true - Max: 100 - AllowURI: true - URISchemes: - - http - - https -Metrics/MethodLength: - Description: Avoid methods longer than 15 lines of code. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#short-methods - Enabled: true - CountComments: true - Max: 15 - Exclude: - - "spec/**/*" -Metrics/ParameterLists: - Description: Avoid long parameter lists. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#too-many-params - Enabled: false - Max: 5 - CountKeywordArgs: true -Metrics/PerceivedComplexity: - Description: A complexity metric geared towards measuring complexity for a human - reader. - Enabled: true - Max: 7 -Lint/AssignmentInCondition: - Description: Don't use assignment in conditions. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#safe-assignment-in-condition - Enabled: false - AllowSafeAssignment: true -Lint/EndAlignment: - Description: Align ends correctly. - Enabled: true - EnforcedStyleAlignWith: keyword - SupportedStylesAlignWith: - - keyword - - variable -Lint/DefEndAlignment: - Description: Align ends corresponding to defs correctly. - Enabled: true - EnforcedStyleAlignWith: start_of_line - SupportedStylesAlignWith: - - start_of_line - - def -Rails/ActionFilter: - Description: Enforces consistent use of action filter methods. - Enabled: true - EnforcedStyle: action - SupportedStyles: - - action - - filter - Include: - - app/controllers/**/*.rb -Rails/HasAndBelongsToMany: - Description: Prefer has_many :through to has_and_belongs_to_many. - Enabled: true - Include: - - app/models/**/*.rb -Rails/Output: - Description: Checks for calls to puts, print, etc. - Enabled: true - Include: - - app/**/*.rb - - config/**/*.rb - - db/**/*.rb - - lib/**/*.rb -Rails/ReadWriteAttribute: - Description: Checks for read_attribute(:attr) and write_attribute(:attr, val). - Enabled: true - Include: - - app/models/**/*.rb -Rails/ScopeArgs: - Description: Checks the arguments of ActiveRecord scopes. - Enabled: true - Include: - - app/models/**/*.rb -Rails/Validation: - Description: Use validates :attribute, hash of validations. - Enabled: true - Include: - - app/models/**/*.rb -Style/InlineComment: - Description: Avoid inline comments. - Enabled: false -Style/MethodCalledOnDoEndBlock: - Description: Avoid chaining a method call on a do...end block. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#single-line-blocks - Enabled: false -Style/SymbolArray: - Description: Use %i or %I for arrays of symbols. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#percent-i - Enabled: false -Layout/ExtraSpacing: - Description: Do not use unnecessary spacing. - Enabled: false -Style/AccessorMethodName: - Description: Check the naming of accessor methods for get_/set_. - Enabled: false -Style/Alias: - Description: Use alias_method instead of alias. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#alias-method - Enabled: false -Layout/AlignArray: - Description: Align the elements of an array literal if they span more than one line. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#align-multiline-arrays - Enabled: true -Style/ArrayJoin: - Description: Use Array#join instead of Array#*. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#array-join - Enabled: false -Style/AsciiComments: - Description: Use only ascii symbols in comments. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#english-comments - Enabled: false -Style/AsciiIdentifiers: - Description: Use only ascii symbols in identifiers. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#english-identifiers - Enabled: false -Style/Attr: - Description: Checks for uses of Module#attr. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#attr - Enabled: false -Style/BeginBlock: - Description: Avoid the use of BEGIN blocks. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-BEGIN-blocks - Enabled: true -Style/BlockComments: - Description: Do not use block comments. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-block-comments - Enabled: false -Layout/BlockEndNewline: - Description: Put end statement of multiline block on its own line. - Enabled: true -Style/CaseEquality: - Description: Avoid explicit use of the case equality operator(===). - StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-case-equality - Enabled: false -Style/CharacterLiteral: - Description: Checks for uses of character literals. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-character-literals - Enabled: false -Style/ClassAndModuleCamelCase: - Description: Use CamelCase for classes and modules. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#camelcase-classes - Enabled: true -Style/ClassMethods: - Description: Use self when defining module/class methods. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#def-self-singletons - Enabled: true -Style/ClassVars: - Description: Avoid the use of class variables. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-class-vars - Enabled: false -Style/ColonMethodCall: - Description: 'Do not use :: for method call.' - StyleGuide: https://github.com/bbatsov/ruby-style-guide#double-colons - Enabled: false -Layout/CommentIndentation: - Description: Indentation of comments. - Enabled: true -Style/ConstantName: - Description: Constants should use SCREAMING_SNAKE_CASE. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#screaming-snake-case - Enabled: true -Style/DefWithParentheses: - Description: Use def with parentheses when there are arguments. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#method-parens - Enabled: true -Style/PreferredHashMethods: - Description: Checks for use of deprecated Hash methods. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#hash-key - Enabled: false -Style/Documentation: - Description: Document classes and non-namespace modules. - Enabled: false -Style/DoubleNegation: - Description: Checks for uses of double negation (!!). - StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-bang-bang - Enabled: false -Style/EachWithObject: - Description: Prefer `each_with_object` over `inject` or `reduce`. - Enabled: false -Layout/ElseAlignment: - Description: Align elses and elsifs correctly. - Enabled: true -Style/EmptyElse: - Description: Avoid empty else-clauses. - Enabled: true -Layout/EmptyLines: - Description: Don't use several empty lines in a row. - Enabled: true -Layout/EmptyLinesAroundAccessModifier: - Description: Keep blank lines around access modifiers. - Enabled: true -Layout/EmptyLinesAroundMethodBody: - Description: Keeps track of empty lines around method bodies. - Enabled: true -Style/EmptyLiteral: - Description: Prefer literals to Array.new/Hash.new/String.new. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#literal-array-hash - Enabled: false -Style/EndBlock: - Description: Avoid the use of END blocks. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-END-blocks - Enabled: true -Layout/EndOfLine: - Description: Use Unix-style line endings. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#crlf - Enabled: true -Style/EvenOdd: - Description: Favor the use of Fixnum#even? && Fixnum#odd? - StyleGuide: https://github.com/bbatsov/ruby-style-guide#predicate-methods - Enabled: false -Style/FlipFlop: - Description: Checks for flip flops - StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-flip-flops - Enabled: false -Style/IfWithSemicolon: - Description: Do not use if x; .... Use the ternary operator instead. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-semicolon-ifs - Enabled: false -Layout/IndentationConsistency: - Description: Keep indentation straight. - Enabled: true -Layout/IndentArray: - Description: Checks the indentation of the first element in an array literal. - Enabled: true -Style/InfiniteLoop: - Description: Use Kernel#loop for infinite loops. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#infinite-loop - Enabled: true -Style/Lambda: - Description: Use the new lambda literal syntax for single-line blocks. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#lambda-multi-line - Enabled: false -Layout/LeadingCommentSpace: - Description: Comments should start with a space. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#hash-space - Enabled: true -Style/LineEndConcatenation: - Description: Use \ instead of + or << to concatenate two string literals at line - end. - Enabled: false -Style/MethodCallWithoutArgsParentheses: - Description: Do not use parentheses for method calls with no arguments. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-args-no-parens - Enabled: true -Style/ModuleFunction: - Description: Checks for usage of `extend self` in modules. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#module-function - Enabled: false -Style/MultilineBlockChain: - Description: Avoid multi-line chains of blocks. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#single-line-blocks - Enabled: false -Layout/MultilineBlockLayout: - Description: Ensures newlines after multiline block do statements. - Enabled: false -Style/MultilineIfThen: - Description: Do not use then for multi-line if/unless. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-then - Enabled: true -Style/MultilineTernaryOperator: - Description: 'Avoid multi-line ?: (the ternary operator); use if/unless instead.' - StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-multiline-ternary - Enabled: true -Style/NegatedIf: - Description: Favor unless over if for negative conditions (or control flow or). - StyleGuide: https://github.com/bbatsov/ruby-style-guide#unless-for-negatives - Enabled: false -Style/NegatedWhile: - Description: Favor until over while for negative conditions. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#until-for-negatives - Enabled: false -Style/NestedTernaryOperator: - Description: Use one expression per branch in a ternary operator. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-nested-ternary - Enabled: true -Style/NilComparison: - Description: Prefer x.nil? to x == nil. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#predicate-methods - Enabled: false -Style/Not: - Description: Use ! instead of not. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#bang-not-not - Enabled: true -Style/OneLineConditional: - Description: Favor the ternary operator(?:) over if/then/else/end constructs. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#ternary-operator - Enabled: false -Style/OpMethod: - Description: When defining binary operators, name the argument other. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#other-arg - Enabled: false -Style/PerlBackrefs: - Description: Avoid Perl-style regex back references. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-perl-regexp-last-matchers - Enabled: false -Style/Proc: - Description: Use proc instead of Proc.new. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#proc - Enabled: false -Style/RedundantBegin: - Description: Don't use begin blocks when they are not needed. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#begin-implicit - Enabled: true -Style/RedundantException: - Description: Checks for an obsolete RuntimeException argument in raise/fail. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-explicit-runtimeerror - Enabled: true -Style/RedundantSelf: - Description: Don't use self where it's not needed. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-self-unless-required - Enabled: true -Style/RescueModifier: - Description: Avoid using rescue in its modifier form. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-rescue-modifiers - Enabled: true -Style/SelfAssignment: - Description: Checks for places where self-assignment shorthand should have been - used. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#self-assignment - Enabled: false -Layout/SpaceAfterColon: - Description: Use spaces after colons. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#spaces-operators - Enabled: true -Layout/SpaceAfterComma: - Description: Use spaces after commas. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#spaces-operators - Enabled: true -Layout/SpaceAroundKeyword: - Description: Use a space around keywords if appropriate. - Enabled: true -Layout/SpaceAfterMethodName: - Description: Do not put a space between a method name and the opening parenthesis - in a method definition. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#parens-no-spaces - Enabled: true -Layout/SpaceAfterNot: - Description: Tracks redundant space after the ! operator. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-space-bang - Enabled: true -Layout/SpaceAfterSemicolon: - Description: Use spaces after semicolons. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#spaces-operators - Enabled: true -Layout/SpaceBeforeComma: - Description: No spaces before commas. - Enabled: true -Layout/SpaceBeforeComment: - Description: Checks for missing space between code and a comment on the same line. - Enabled: true -Layout/SpaceBeforeFirstArg: - Description: Put a space between a method name and the first argument in a method - call without parentheses. - Enabled: true -Layout/SpaceBeforeSemicolon: - Description: No spaces before semicolons. - Enabled: true -Layout/SpaceAroundOperators: - Description: Use spaces around operators. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#spaces-operators - Enabled: true -Layout/SpaceInsideBrackets: - Description: No spaces after [ or before ]. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-spaces-braces - Enabled: true -Layout/SpaceInsideParens: - Description: No spaces after ( or before ). - StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-spaces-braces - Enabled: true -Layout/SpaceInsideRangeLiteral: - Description: No spaces inside range literals. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-space-inside-range-literals - Enabled: true -Style/SpecialGlobalVars: - Description: Avoid Perl-style global variables. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-cryptic-perlisms - Enabled: false -Style/StructInheritance: - Description: Checks for inheritance from Struct.new. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-extend-struct-new - Enabled: true -Layout/Tab: - Description: No hard tabs. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#spaces-indentation - Enabled: true -Layout/TrailingWhitespace: - Description: Avoid trailing whitespace. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-trailing-whitespace - Enabled: true -Style/UnlessElse: - Description: Do not use unless with else. Rewrite these with the positive case first. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-else-with-unless - Enabled: true -Style/UnneededCapitalW: - Description: Checks for %W when interpolation is not needed. - Enabled: true -Style/UnneededPercentQ: - Description: Checks for %q/%Q when single quotes or double quotes would do. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#percent-q - Enabled: true -Style/VariableInterpolation: - Description: Don't interpolate global, instance and class variables directly in - strings. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#curlies-interpolate - Enabled: false -Style/WhenThen: - Description: Use when x then ... for one-line cases. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#one-line-cases - Enabled: false -Style/WhileUntilDo: - Description: Checks for redundant do after while or until. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-multiline-while-do - Enabled: true -Lint/AmbiguousOperator: - Description: Checks for ambiguous operators in the first argument of a method invocation - without parentheses. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#parens-as-args - Enabled: false -Lint/AmbiguousRegexpLiteral: - Description: Checks for ambiguous regexp literals in the first argument of a method - invocation without parenthesis. - Enabled: false -Lint/BlockAlignment: - Description: Align block ends correctly. - Enabled: true -Lint/ConditionPosition: - Description: Checks for condition placed in a confusing position relative to the - keyword. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#same-line-condition - Enabled: false -Lint/Debugger: - Description: Check for debugger calls. - Enabled: true -Lint/DeprecatedClassMethods: - Description: Check for deprecated class method calls. - Enabled: false -Lint/DuplicateMethods: - Description: Check for duplicate methods calls. - Enabled: true -Lint/ElseLayout: - Description: Check for odd code arrangement in an else block. - Enabled: false -Lint/EmptyEnsure: - Description: Checks for empty ensure block. - Enabled: true -Lint/EmptyInterpolation: - Description: Checks for empty string interpolation. - Enabled: true -Lint/EndInMethod: - Description: END blocks should not be placed inside method definitions. - Enabled: true -Lint/EnsureReturn: - Description: Do not use return in an ensure block. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-return-ensure - Enabled: true -Security/Eval: - Description: The use of eval represents a serious security risk. - Enabled: true -Lint/HandleExceptions: - Description: Don't suppress exception. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#dont-hide-exceptions - Enabled: false -Lint/InvalidCharacterLiteral: - Description: Checks for invalid character literals with a non-escaped whitespace - character. - Enabled: false -Lint/LiteralInCondition: - Description: Checks of literals used in conditions. - Enabled: false -Lint/LiteralInInterpolation: - Description: Checks for literals used in interpolation. - Enabled: false -Lint/Loop: - Description: Use Kernel#loop with break rather than begin/end/until or begin/end/while - for post-loop tests. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#loop-with-break - Enabled: false -Lint/ParenthesesAsGroupedExpression: - Description: Checks for method calls with a space before the opening parenthesis. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#parens-no-spaces - Enabled: false -Lint/RequireParentheses: - Description: Use parentheses in the method call to avoid confusion about precedence. - Enabled: false -Lint/RescueException: - Description: Avoid rescuing the Exception class. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-blind-rescues - Enabled: true -Lint/ShadowingOuterLocalVariable: - Description: Do not use the same name as outer local variable for block arguments - or block local variables. - Enabled: true -Lint/StringConversionInInterpolation: - Description: Checks for Object#to_s usage in string interpolation. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-to-s - Enabled: true -Lint/UnderscorePrefixedVariableName: - Description: Do not use prefix `_` for a variable that is used. - Enabled: false -Lint/UnusedBlockArgument: - Description: Checks for unused block arguments. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#underscore-unused-vars - Enabled: true -Lint/UnusedMethodArgument: - Description: Checks for unused method arguments. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#underscore-unused-vars - Enabled: true -Lint/UnreachableCode: - Description: Unreachable code. - Enabled: true -Lint/UselessAccessModifier: - Description: Checks for useless access modifiers. - Enabled: true -Lint/UselessAssignment: - Description: Checks for useless assignment to a local variable. - StyleGuide: https://github.com/bbatsov/ruby-style-guide#underscore-unused-vars - Enabled: true -Lint/UselessComparison: - Description: Checks for comparison of something with itself. - Enabled: true -Lint/UselessElseWithoutRescue: - Description: Checks for useless `else` in `begin..end` without `rescue`. - Enabled: true -Lint/UselessSetterCall: - Description: Checks for useless setter call to a local variable. - Enabled: true -Lint/Void: - Description: Possible use of operator/literal/variable in void context. - Enabled: false -Rails/Delegate: - Description: Prefer delegate method for delegations. - Enabled: false -Performance/RedundantBlockCall: - Description: Use `yield` instead of `block.call`. - Reference: https://github.com/JuanitoFatas/fast-ruby#proccall-vs-yield-code - Enabled: false diff --git a/.hound/stylelintrc.json b/.hound/stylelintrc.json deleted file mode 100644 index 453cee15..00000000 --- a/.hound/stylelintrc.json +++ /dev/null @@ -1,50 +0,0 @@ -{ - "rules": { - "declaration-bang-space-before": "always", - "declaration-bang-space-after": "never", - "declaration-property-value-blacklist": { - "/^border/": ["none"] - }, - "color-named": "never", - "stylelint-disable-reason": "always-before", - "declaration-block-no-duplicate-properties": true, - "rule-empty-line-before": [ - "always-multi-line", - { - "except": ["after-single-line-comment", "first-nested"] - } - ], - "block-no-empty": true, - "no-missing-end-of-source-newline": true, - "color-hex-length": "short", - "color-hex-case": "lower", - "color-no-invalid-hex": true, - "selector-no-id": true, - "declaration-no-important": true, - "indentation": 2, - "number-leading-zero": "never", - "no-duplicate-selectors": true, - "max-nesting-depth": 3, - "selector-pseudo-element-colon-notation": "double", - "selector-no-qualifying-type": true, - "shorthand-property-no-redundant-values": true, - "declaration-block-semicolon-newline-after": "always-multi-line", - "selector-list-comma-newline-after": "always", - "function-comma-space-after": "always-single-line", - "declaration-colon-space-after": "always", - "declaration-colon-space-before": "never", - "block-opening-brace-space-before": "always", - "function-parentheses-space-inside": "never", - "string-quotes": "single", - "declaration-block-trailing-semicolon": "always", - "no-eol-whitespace": true, - "number-no-trailing-zeros": true, - "function-url-quotes": "always", - "property-no-vendor-prefix": true, - "selector-no-vendor-prefix": true, - "media-feature-name-no-vendor-prefix": true, - "at-rule-no-vendor-prefix": true, - "value-no-vendor-prefix": true, - "length-zero-no-unit": true - } -} diff --git a/.hound/tslint.json b/.hound/tslint.json deleted file mode 100644 index f4b8c7ba..00000000 --- a/.hound/tslint.json +++ /dev/null @@ -1,115 +0,0 @@ -{ - "rules": { - "align": [true, "parameters", "arguments", "statements"], - "class-name": true, - "comment-format": [true, "check-space"], - "curly": true, - "eofline": true, - "forin": true, - "indent": [true, "spaces"], - "interface-name": [true, "never-prefix"], - "jsdoc-format": true, - "label-position": true, - "label-undefined": true, - "max-line-length": [true, 120], - "member-access": true, - "member-ordering": [ - true, - { - "order": "statics-first" - } - ], - "new-parens": true, - "no-any": false, - "no-arg": true, - "no-bitwise": true, - "no-conditional-assignment": true, - "no-consecutive-blank-lines": true, - "no-console": [true, "debug", "info", "log", "time", "timeEnd", "trace"], - "no-default-export": true, - "no-construct": true, - "no-constructor-vars": false, - "no-debugger": true, - "no-duplicate-key": true, - "no-duplicate-variable": true, - "no-empty": true, - "no-eval": true, - "no-internal-module": true, - "no-invalid-this": true, - "no-namespace": true, - "no-reference": true, - "no-shadowed-variable": true, - "no-string-literal": true, - "no-switch-case-fall-through": false, - "no-trailing-whitespace": true, - "no-unreachable": true, - "no-unused-expression": true, - "no-unused-variable": [true], - "no-use-before-declare": false, - "no-var-keyword": true, - "no-var-requires": true, - "object-literal-sort-keys": false, - "one-line": [ - true, - "check-catch", - "check-else", - "check-finally", - "check-open-brace", - "check-whitespace" - ], - "one-variable-per-declaration": [true, "ignore-for-loop"], - "quotemark": [true, "single", "avoid-escape"], - "radix": true, - "semicolon": [true, "always"], - "switch-default": false, - "trailing-comma": [ - true, - { - "singleline": "never", - "multiline": "always" - } - ], - "triple-equals": [true], - "typedef": [ - true, - "member-variable-declaration", - "variable-declaration", - "property-declaration", - "parameter" - ], - "typedef-whitespace": [ - true, - { - "call-signature": "nospace", - "index-signature": "nospace", - "parameter": "nospace", - "property-declaration": "nospace", - "variable-declaration": "nospace" - }, - { - "call-signature": "onespace", - "index-signature": "onespace", - "parameter": "onespace", - "property-declaration": "onespace", - "variable-declaration": "onespace" - } - ], - "use-isnan": true, - "variable-name": [ - true, - "ban-keywords", - "check-format", - "allow-pascal-case" - ], - "whitespace": [ - true, - "check-branch", - "check-decl", - "check-module", - "check-operator", - "check-separator", - "check-type", - "check-typecast" - ] - } -} From 808cd1d17c1311ee3a2e6e84c568aba9cf97a20d Mon Sep 17 00:00:00 2001 From: Talha Mansoor <talha131@gmail.com> Date: Mon, 1 Jul 2019 15:50:31 +0500 Subject: [PATCH 20/52] fix(home): remove redundant title --- templates/index.html | 2 -- 1 file changed, 2 deletions(-) diff --git a/templates/index.html b/templates/index.html index a71ee001..09d64edc 100644 --- a/templates/index.html +++ b/templates/index.html @@ -39,8 +39,6 @@ {% set landing_page.page = p %} {% endfor %} -{{landing_page.page.title}} - <div class="row-fluid"> {% if LANDING_PAGE_TITLE %} {% set css_class = 'span10 offset2' %} From ab4cc7d9340d6763f0b13aa44914661910bea4af Mon Sep 17 00:00:00 2001 From: Talha Mansoor <talha131@gmail.com> Date: Mon, 1 Jul 2019 16:12:49 +0500 Subject: [PATCH 21/52] docs(add): split landing page article into new articles --- .../Building Readership/landing-page.md | 102 ------------------ .../content/Landing Page/about-me.md | 45 ++++++++ .../content/Landing Page/landing-page.md | 34 ++++++ .../content/Landing Page/projects-list.md | 38 +++++++ .../content/Landing Page/recent-articles.md | 15 +++ documentation/content/Landing Page/welcome.md | 17 +++ 6 files changed, 149 insertions(+), 102 deletions(-) delete mode 100644 documentation/content/Building Readership/landing-page.md create mode 100644 documentation/content/Landing Page/about-me.md create mode 100644 documentation/content/Landing Page/landing-page.md create mode 100644 documentation/content/Landing Page/projects-list.md create mode 100644 documentation/content/Landing Page/recent-articles.md create mode 100644 documentation/content/Landing Page/welcome.md diff --git a/documentation/content/Building Readership/landing-page.md b/documentation/content/Building Readership/landing-page.md deleted file mode 100644 index 4699242c..00000000 --- a/documentation/content/Building Readership/landing-page.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -Title: Customize Home Page -Tags: nuances, remarkable, unique -layout: post -Date: 2019-07-01 01:22 -comments: false -Slug: customize-home-page -Category: Building Readership ---- - -This is the page that visitors see when they open your website. Your chance to -make a good and lasting first impression. Most sites just display a list of -recent posts. Elegant goes the extra mile. Check this out - -![Home Page Sample]({static}/images/elegant-theme_home-page-features.png) - -You can see two sections here, - -1. About me -1. My Projects - -There is a third section below these two sections, "Recent articles" - -![Recent Articles Section]({static}/images/elegant-theme_recent-posts.png) - -## Welcome Heading - -Define `LANDING_PAGE_TITLE` in your Pelican configuration. It will be displayed as the welcome heading. For example, - -```python -LANDING_PAGE_TITLE = "Elegant – Why it is the Best Pelican Theme" -``` - -## About Me - -To write about me section, create a page. See [Pelican documentation](http://docs.getpelican.com/en/stable/content.html#pages) on how to create a page. - -The slug of the page should be `landing-page-about-hidden` and `status` should be `hidden`. Example, - -```yaml ---- -author: Talha Mansoor -title: What Is Elegant -layout: page -date: 2019-01-14 7:30:47 +0100 -status: hidden -slug: landing-page-about-hidden ---- - -``` - -The content of this will become your "About me" section, and title will become the heading. You can write content in any markup language, like Markdown, AsciiDoc or reST, as long as Pelican has supports it. - -### Deprecated - -!!! Danger "Warning: Legacy Variable" - - `LANDING_PAGE_ABOUT` was available in Elegant V2.5.0. It has since been passed out in favour of `landing-page-about-hidden`. The new method lets you write "About Me" in your favourite markup language. - -You can write up your own About me section using `LANDING_PAGE_ABOUT` variable -in your configuration. It is a dictionary that has two keys `title` and -`details`. - -Value of `title` is displayed in the header of the home page, like -in the above example it is "I design and build software products for iOS and -OSX". - -`details` is the text that appears under "About me" heading. You can add raw HTML to it. - -## Projects - -Projects list is read from `PROJECTS`. It is an array of dictionaries. Each -dictionary has three keys, - -1. `name` which will have name of your project, -1. `url` which will have URL of the project, and -1. `description` which will have the description of the project. - -You can define as many projects as you want. Here -is an example, - - #!Python - PROJECTS = [{ - 'name': 'Logpad + Duration', - 'url': 'https://github.com/talha131/logpad-plus-duration#logpad--duration', - 'description': 'Vim plugin to emulate Windows Notepad logging feature,' - ' and log duration of each entry'}, - {'name': 'Elegant Theme for Pelican', - 'url': 'http://oncrashreboot.com/pelican-elegant', - 'description': 'A clean and distraction free theme, with search and a' - ' lot more unique features, using Jinja2 and Bootstrap'}] - -To configure the projects' list title, set `PROJECTS_TITLE` variable in your Pelican configuration. Its default value is "My Projects". For example, - -```python -PROJECTS_TITLE = "Related Projects" -``` - -### Recent Articles - -Recent articles show last `RECENT_ARTICLES_COUNT` whose default value is 10. It -also has a link to "all posts". diff --git a/documentation/content/Landing Page/about-me.md b/documentation/content/Landing Page/about-me.md new file mode 100644 index 00000000..834d9875 --- /dev/null +++ b/documentation/content/Landing Page/about-me.md @@ -0,0 +1,45 @@ +--- +Title: Write About Me +Tags: remarkable, unique, home +layout: post +Date: 2019-07-01 01:12 +comments: false +Slug: write-about-me +Category: Landing Page +--- + +To write about me section, create a page. See [Pelican documentation](http://docs.getpelican.com/en/stable/content.html#pages) on how to create a page. + +The slug of the page should be `landing-page-about-hidden` and `status` should be `hidden`. Example, + +```yaml +--- +author: Talha Mansoor +title: What Is Elegant +layout: page +date: 2019-01-14 7:30:47 +0100 +status: hidden +slug: landing-page-about-hidden +--- + +``` + +The content of this will become your "About me" section, and title will become the heading. You can write content in any markup language, like Markdown, AsciiDoc or reST, as long as Pelican has supports it. + +![Home Page Sample]({static}/images/elegant-theme_home-page-features.png) + +### Deprecated + +!!! Danger "Warning: Legacy Variable" + + `LANDING_PAGE_ABOUT` was available in Elegant V2.5.0. It has since been passed out in favour of `landing-page-about-hidden`. The new method lets you write "About Me" in your favourite markup language. + +You can write up your own About me section using `LANDING_PAGE_ABOUT` variable +in your configuration. It is a dictionary that has two keys `title` and +`details`. + +Value of `title` is displayed in the header of the home page, like +in the above example it is "I design and build software products for iOS and +OSX". + +`details` is the text that appears under "About me" heading. You can add raw HTML to it. diff --git a/documentation/content/Landing Page/landing-page.md b/documentation/content/Landing Page/landing-page.md new file mode 100644 index 00000000..9980ef5c --- /dev/null +++ b/documentation/content/Landing Page/landing-page.md @@ -0,0 +1,34 @@ +--- +Title: Unique Home Page Features +Tags: home, remarkable, unique, guide +layout: post +Date: 2019-07-31 01:22 +comments: false +Slug: unique-home-page-features +Category: Landing Page +--- + +This is the page that visitors see when they open your website. Your chance to +make a good and lasting first impression. Most sites just display a list of +recent posts. Elegant goes the extra mile. Check this out + +![Home Page Sample]({static}/images/elegant-theme_home-page-features.png) + +You can see three features here, + +1. Welcome Heading +1. About me +1. My Projects + +There is a third section below these two sections, "Recent articles". + +![Recent Articles Section]({static}/images/elegant-theme_recent-posts.png) + +## How to set them up + +We have detailed help articles to help you set these sections up + +1. [Write Welcome Message]({filename}./welcome.md) +1. [Write About Me]({filename}./about-me.md) +1. [Projects List]({filename}./projects-list.md) +1. [Recent Articles List]({filename}./recent-articles.md) diff --git a/documentation/content/Landing Page/projects-list.md b/documentation/content/Landing Page/projects-list.md new file mode 100644 index 00000000..8a70606c --- /dev/null +++ b/documentation/content/Landing Page/projects-list.md @@ -0,0 +1,38 @@ +--- +Title: Projects List +Tags: remarkable, unique, home +layout: post +Date: 2019-07-01 01:12 +comments: false +Slug: projects-list +Category: Landing Page +--- + +Projects list is read from `PROJECTS`. It is an array of dictionaries. Each +dictionary has three keys, + +1. `name` which will have name of your project, +1. `url` which will have URL of the project, and +1. `description` which will have the description of the project. + +You can define as many projects as you want. Here +is an example, + + #!Python + PROJECTS = [{ + 'name': 'Logpad + Duration', + 'url': 'https://github.com/talha131/logpad-plus-duration#logpad--duration', + 'description': 'Vim plugin to emulate Windows Notepad logging feature,' + ' and log duration of each entry'}, + {'name': 'Elegant Theme for Pelican', + 'url': 'http://oncrashreboot.com/pelican-elegant', + 'description': 'A clean and distraction free theme, with search and a' + ' lot more unique features, using Jinja2 and Bootstrap'}] + +To configure the projects' list title, set `PROJECTS_TITLE` variable in your Pelican configuration. Its default value is "My Projects". For example, + +```python +PROJECTS_TITLE = "Related Projects" +``` + +![Home Page Sample]({static}/images/elegant-theme_home-page-features.png) diff --git a/documentation/content/Landing Page/recent-articles.md b/documentation/content/Landing Page/recent-articles.md new file mode 100644 index 00000000..57d7810c --- /dev/null +++ b/documentation/content/Landing Page/recent-articles.md @@ -0,0 +1,15 @@ +--- +Title: Recent Articles List +Tags: remarkable, unique, home +layout: post +Date: 2019-07-01 01:10 +comments: false +Slug: recent-articles-list +Category: Landing Page +--- + +Recent articles show last `RECENT_ARTICLES_COUNT` whose default value is 10. + +It also has a link to "all posts", which takes user to the archives page. + +![Recent Articles Section]({static}/images/elegant-theme_recent-posts.png) diff --git a/documentation/content/Landing Page/welcome.md b/documentation/content/Landing Page/welcome.md new file mode 100644 index 00000000..7b44e3ba --- /dev/null +++ b/documentation/content/Landing Page/welcome.md @@ -0,0 +1,17 @@ +--- +Title: Write Welcome Message +Tags: remarkable, unique, home +layout: post +Date: 2019-07-01 01:12 +comments: false +Slug: write-welcome-message +Category: Landing Page +--- + +Define `LANDING_PAGE_TITLE` in your Pelican configuration. It will be displayed as the welcome heading. For example, + +```python +LANDING_PAGE_TITLE = "I design and build software products for iOS and OSX" +``` + +![Home Page Sample]({static}/images/elegant-theme_home-page-features.png) From b3ba86f78c5a2462d762cbaaabad6ee0dd8960b6 Mon Sep 17 00:00:00 2001 From: Talha Mansoor <talha131@gmail.com> Date: Mon, 1 Jul 2019 16:21:44 +0500 Subject: [PATCH 22/52] docs(add): extract articles --- .../Elegant - Pelican Theme/elegant-theme.md | 46 ------------------- .../article-count.md | 2 +- documentation/content/Taxonomy/filter-tags.md | 29 ++++++++++++ .../content/Taxonomy/zero-clutter-category.md | 30 ++++++++++++ 4 files changed, 60 insertions(+), 47 deletions(-) rename documentation/content/{Appearance and Style => Taxonomy}/article-count.md (97%) create mode 100644 documentation/content/Taxonomy/filter-tags.md create mode 100644 documentation/content/Taxonomy/zero-clutter-category.md diff --git a/documentation/content/Elegant - Pelican Theme/elegant-theme.md b/documentation/content/Elegant - Pelican Theme/elegant-theme.md index 3363cc18..091cdb08 100644 --- a/documentation/content/Elegant - Pelican Theme/elegant-theme.md +++ b/documentation/content/Elegant - Pelican Theme/elegant-theme.md @@ -41,52 +41,6 @@ page. ![Search box]({static}/images/elegant-theme_search-box.png) -## Live Filter for Tags - -Elegant is a minimal theme. Instead of creating separate pages for each tag, -Elegant shows all the tags on a single page. To help visitor find the tags he -is interested in, Elegant offers live filter. - -Go to tags page and type your required tag in "Find a tag" search box. Elegant -will automatically filter the list. - -For example, this is how my tags page looks like - -![Tags view -unfiltered]({static}/images/elegant-theme_tags-live-filter-default.png) - -As soon as I type "os", all other tags are filtered out - -![Tags view filtered for -"os"]({static}/images/elegant-theme_tags-live-filter-filtered.png) - -With live filter, your reader will have no difficulty in picking up his desired -tag from the list, even if your site has hundreds of tags. - -## All Categories but with zero clutter - -Pelican by default creates a separate page for each category. Themes list all -the articles filed in that category at its page. Elegant takes a different -approach. - -It lists all the categories and their articles on the same page. To reduce -clutter and utilize space efficiently, each category and its list of articles -is enclosed in [collapsible -accordions](http://getbootstrap.com/2.3.2/javascript.html#collapse). - -Here is how categories appear collapsed - -![Categories accordions -collapsed]({static}/images/elegant-theme_category-accordions-collapsed.png) - -And this is how they appear uncollapsed - -![Categories accordions -uncollapsed]({static}/images/elegant-theme_category-accordions-uncollapsed.png) - -Did you notice that categories are listed in ascending alphabetical order and -articles are sorted by their date in descending order? - ## Mailchimp Mailchimp has become the preferred newsletter service. Elegant shows a form to diff --git a/documentation/content/Appearance and Style/article-count.md b/documentation/content/Taxonomy/article-count.md similarity index 97% rename from documentation/content/Appearance and Style/article-count.md rename to documentation/content/Taxonomy/article-count.md index f53c2094..4dcd5443 100644 --- a/documentation/content/Appearance and Style/article-count.md +++ b/documentation/content/Taxonomy/article-count.md @@ -5,7 +5,7 @@ layout: post Date: 2013-08-27 23:20 comments: false Slug: articles-count-with-every-tag-and-category -Category: Appearance & Style +Category: Taxanomy --- Readers of an article on your site usually look for other articles on the same diff --git a/documentation/content/Taxonomy/filter-tags.md b/documentation/content/Taxonomy/filter-tags.md new file mode 100644 index 00000000..626c7d01 --- /dev/null +++ b/documentation/content/Taxonomy/filter-tags.md @@ -0,0 +1,29 @@ +--- +Title: Live Filter for Tags +Tags: nuances, search +layout: post +Date: 2013-08-27 23:20 +comments: false +Slug: live-filter-for-tags +Category: Taxanomy +--- + +Elegant is a minimal theme. Instead of creating separate pages for each tag, +Elegant shows all the tags on a single page. To help visitor find the tags he +is interested in, Elegant offers live filter. + +Go to tags page and type your required tag in "Find a tag" search box. Elegant +will automatically filter the list. + +For example, this is how my tags page looks like + +![Tags view +unfiltered]({static}/images/elegant-theme_tags-live-filter-default.png) + +As soon as I type "os", all other tags are filtered out + +![Tags view filtered for +"os"]({static}/images/elegant-theme_tags-live-filter-filtered.png) + +With live filter, your reader will have no difficulty in picking up his desired +tag from the list, even if your site has hundreds of tags. diff --git a/documentation/content/Taxonomy/zero-clutter-category.md b/documentation/content/Taxonomy/zero-clutter-category.md new file mode 100644 index 00000000..1d7cb8a8 --- /dev/null +++ b/documentation/content/Taxonomy/zero-clutter-category.md @@ -0,0 +1,30 @@ +--- +Title: Zero Clutter Categories +Tags: nuances, clean +layout: post +Date: 2013-08-27 23:20 +comments: false +Slug: zero-clutter-categories +Category: Taxanomy +--- + +Pelican by default creates a separate page for each category. Themes list all +the articles filed in that category at its page. Elegant takes a different +approach which is, "all Categories but with zero clutter". + +It lists all the categories and their articles on the same page. To reduce +clutter and utilize space efficiently, each category and its list of articles +is enclosed in [collapsible accordions](http://getbootstrap.com/2.3.2/javascript.html#collapse). + +Here is how categories appear collapsed + +![Categories accordions +collapsed]({static}/images/elegant-theme_category-accordions-collapsed.png) + +And this is how they appear uncollapsed + +![Categories accordions +uncollapsed]({static}/images/elegant-theme_category-accordions-uncollapsed.png) + +Did you notice that categories are listed in ascending alphabetical order and +articles are sorted by their date in descending order? From 0995513674357a881e85ef66b6b69634042b1088 Mon Sep 17 00:00:00 2001 From: Talha Mansoor <talha131@gmail.com> Date: Mon, 1 Jul 2019 16:32:22 +0500 Subject: [PATCH 23/52] docs(add): add articles on mailchimp and freelists fix #304 --- .../Elegant - Pelican Theme/elegant-theme.md | 14 ------------ .../content/Mailing List/freelists.md | 22 +++++++++++++++++++ .../content/Mailing List/mailchimp.md | 22 +++++++++++++++++++ 3 files changed, 44 insertions(+), 14 deletions(-) create mode 100644 documentation/content/Mailing List/freelists.md create mode 100644 documentation/content/Mailing List/mailchimp.md diff --git a/documentation/content/Elegant - Pelican Theme/elegant-theme.md b/documentation/content/Elegant - Pelican Theme/elegant-theme.md index 091cdb08..f0c22e6c 100644 --- a/documentation/content/Elegant - Pelican Theme/elegant-theme.md +++ b/documentation/content/Elegant - Pelican Theme/elegant-theme.md @@ -41,20 +41,6 @@ page. ![Search box]({static}/images/elegant-theme_search-box.png) -## Mailchimp - -Mailchimp has become the preferred newsletter service. Elegant shows a form to -subscribe to your newsletter, above the fold, in the right section of every -article. Increased visibility is said to increase number of subscribers. - -![Mailchimp subscriber -form]({static}/images/elegant-theme_subscribe-form.png) - -You need to put your Mailchimp form action URL in `MAILCHIMP_FORM_ACTION` in -your configuration file. You can also define `EMAIL_SUBSCRIPTION_LABEL`, -`EMAIL_FIELD_PLACEHOLDER` and `SUBSCRIBE_BUTTON_TITLE` to customize user -experience. - ## Custom 404 Page Elegant has a custom Error 404 page for your readers. diff --git a/documentation/content/Mailing List/freelists.md b/documentation/content/Mailing List/freelists.md new file mode 100644 index 00000000..bf828877 --- /dev/null +++ b/documentation/content/Mailing List/freelists.md @@ -0,0 +1,22 @@ +--- +Title: Add FreeLists +Tags: marketing, network, subscriber +layout: post +Date: 2018-07-05 23:20 +comments: false +Slug: add-freelists +Category: Mailing List +--- + +Elegant shows a form to subscribe to your newsletter, above the fold, in the right section of every article. Increased visibility is said to increase number of subscribers. + +![Mailchimp subscriber +form]({static}/images/elegant-theme_subscribe-form.png) + +You need to put your FreeList name in `FREELISTS_NAME` in your configuration file. + +To customize user experience you can also define, + +1. `EMAIL_SUBSCRIPTION_LABEL`, +1. `EMAIL_FIELD_PLACEHOLDER` and +1. `SUBSCRIBE_BUTTON_TITLE` diff --git a/documentation/content/Mailing List/mailchimp.md b/documentation/content/Mailing List/mailchimp.md new file mode 100644 index 00000000..fce1a24a --- /dev/null +++ b/documentation/content/Mailing List/mailchimp.md @@ -0,0 +1,22 @@ +--- +Title: Add Mailchimp +Tags: marketing, network, subscriber +layout: post +Date: 2013-08-27 23:20 +comments: false +Slug: add-mailchimp +Category: Mailing List +--- + +Elegant shows a form to subscribe to your newsletter, above the fold, in the right section of every article. Increased visibility is said to increase number of subscribers. + +![Mailchimp subscriber +form]({static}/images/elegant-theme_subscribe-form.png) + +You need to put your Mailchimp form action URL in `MAILCHIMP_FORM_ACTION` in your configuration file. + +To customize user experience you can also define, + +1. `EMAIL_SUBSCRIPTION_LABEL`, +1. `EMAIL_FIELD_PLACEHOLDER` and +1. `SUBSCRIBE_BUTTON_TITLE` From c346d1fa5a04bf05b032eb9720bb918158a0a279 Mon Sep 17 00:00:00 2001 From: Talha Mansoor <talha131@gmail.com> Date: Mon, 1 Jul 2019 16:45:54 +0500 Subject: [PATCH 24/52] fix(freelists): use SUBSCRIBE_BUTTON_TITLE instead of generic GO --- templates/_includes/freelists.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/templates/_includes/freelists.html b/templates/_includes/freelists.html index 7604acaa..3bd3802b 100644 --- a/templates/_includes/freelists.html +++ b/templates/_includes/freelists.html @@ -19,7 +19,7 @@ <h4>{{ EMAIL_SUBSCRIPTION_LABEL }}</h4> <option value="unset vacation">Turn Vacation mode off</option> <option value="help">Get Help</option> </select> -<input type=submit value="Go!" class="button"> +<input type=submit value={{SUBSCRIBE_BUTTON_TITLE}} class="button"> </form> <!-- END FreeLists WEB FORM --> </div> From a27064fa1fb4318790983933af4b329fb50a5015 Mon Sep 17 00:00:00 2001 From: Talha Mansoor <talha131@gmail.com> Date: Mon, 1 Jul 2019 16:49:11 +0500 Subject: [PATCH 25/52] chore(docs): remove nl2br markdown extension --- documentation/pelicanconf.py | 1 - 1 file changed, 1 deletion(-) diff --git a/documentation/pelicanconf.py b/documentation/pelicanconf.py index 030205f8..04b7d4ee 100644 --- a/documentation/pelicanconf.py +++ b/documentation/pelicanconf.py @@ -22,7 +22,6 @@ "markdown.extensions.codehilite": {"css_class": "highlight"}, "markdown.extensions.extra": {}, "markdown.extensions.meta": {}, - "markdown.extensions.nl2br": {}, "markdown.extensions.toc": {"permalink": "true"}, } } From 126968427fd3a2af472c9eba48da526bb0b09260 Mon Sep 17 00:00:00 2001 From: Talha Mansoor <talha131@gmail.com> Date: Mon, 1 Jul 2019 17:05:56 +0500 Subject: [PATCH 26/52] docs(update): add warning that freelists form is not working re #412 --- documentation/content/Mailing List/freelists.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/documentation/content/Mailing List/freelists.md b/documentation/content/Mailing List/freelists.md index bf828877..cf389cf6 100644 --- a/documentation/content/Mailing List/freelists.md +++ b/documentation/content/Mailing List/freelists.md @@ -8,10 +8,7 @@ Slug: add-freelists Category: Mailing List --- -Elegant shows a form to subscribe to your newsletter, above the fold, in the right section of every article. Increased visibility is said to increase number of subscribers. - -![Mailchimp subscriber -form]({static}/images/elegant-theme_subscribe-form.png) +Elegant shows a form to subscribe to your newsletter, above the fold, in the right section of every article. You need to put your FreeList name in `FREELISTS_NAME` in your configuration file. @@ -20,3 +17,11 @@ To customize user experience you can also define, 1. `EMAIL_SUBSCRIPTION_LABEL`, 1. `EMAIL_FIELD_PLACEHOLDER` and 1. `SUBSCRIBE_BUTTON_TITLE` + +!!! Warning + + FreeList has deprecated the form Elegant used. Due to which, + user is redireced to FreeLists [deprecation notice page](https://www.freelists.org/cgi-bin/subscription.cgi). + If your `FREELISTS_NAME` is correct then their notice page has a link to their new form. + + Fixing this issue is on our roadmap. You can track it [here](https://github.com/Pelican-Elegant/elegant/issues/412). From 60c918480b8a98c49281c024db022c8eef582574 Mon Sep 17 00:00:00 2001 From: Talha Mansoor <talha131@gmail.com> Date: Mon, 1 Jul 2019 17:16:31 +0500 Subject: [PATCH 27/52] fix(admonition): links should inherit the admonition color Without this patch, links inside admonition get black color. The color that we use for links inside articles. But we don't wants links to standout in admonition. Therefore, they should inherit the color. --- static/css/admonition.css | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/static/css/admonition.css b/static/css/admonition.css index 5455fdc2..9edddef6 100644 --- a/static/css/admonition.css +++ b/static/css/admonition.css @@ -16,6 +16,10 @@ div.admonition p { padding: 0; } +div.admonition p a { + color: inherit !important; +} + div.admonition pre { margin: 0.4em 1em 0.4em 1em; } From 6670ddd60366d9b9239aac9ce2fc916f555492fc Mon Sep 17 00:00:00 2001 From: Talha Mansoor <talha131@gmail.com> Date: Mon, 1 Jul 2019 17:20:28 +0500 Subject: [PATCH 28/52] docs(update): fix spellings --- documentation/content/Mailing List/freelists.md | 4 ++-- documentation/content/Taxonomy/article-count.md | 2 +- documentation/content/Taxonomy/filter-tags.md | 2 +- documentation/content/Taxonomy/zero-clutter-category.md | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/documentation/content/Mailing List/freelists.md b/documentation/content/Mailing List/freelists.md index cf389cf6..cc0915a5 100644 --- a/documentation/content/Mailing List/freelists.md +++ b/documentation/content/Mailing List/freelists.md @@ -10,7 +10,7 @@ Category: Mailing List Elegant shows a form to subscribe to your newsletter, above the fold, in the right section of every article. -You need to put your FreeList name in `FREELISTS_NAME` in your configuration file. +You need to put your FreeLists name in `FREELISTS_NAME` in your configuration file. To customize user experience you can also define, @@ -20,7 +20,7 @@ To customize user experience you can also define, !!! Warning - FreeList has deprecated the form Elegant used. Due to which, + FreeLists has deprecated the form Elegant used. Due to which, user is redireced to FreeLists [deprecation notice page](https://www.freelists.org/cgi-bin/subscription.cgi). If your `FREELISTS_NAME` is correct then their notice page has a link to their new form. diff --git a/documentation/content/Taxonomy/article-count.md b/documentation/content/Taxonomy/article-count.md index 4dcd5443..d1d89664 100644 --- a/documentation/content/Taxonomy/article-count.md +++ b/documentation/content/Taxonomy/article-count.md @@ -5,7 +5,7 @@ layout: post Date: 2013-08-27 23:20 comments: false Slug: articles-count-with-every-tag-and-category -Category: Taxanomy +Category: Taxonomy --- Readers of an article on your site usually look for other articles on the same diff --git a/documentation/content/Taxonomy/filter-tags.md b/documentation/content/Taxonomy/filter-tags.md index 626c7d01..c1abcf67 100644 --- a/documentation/content/Taxonomy/filter-tags.md +++ b/documentation/content/Taxonomy/filter-tags.md @@ -5,7 +5,7 @@ layout: post Date: 2013-08-27 23:20 comments: false Slug: live-filter-for-tags -Category: Taxanomy +Category: Taxonomy --- Elegant is a minimal theme. Instead of creating separate pages for each tag, diff --git a/documentation/content/Taxonomy/zero-clutter-category.md b/documentation/content/Taxonomy/zero-clutter-category.md index 1d7cb8a8..0f538a1e 100644 --- a/documentation/content/Taxonomy/zero-clutter-category.md +++ b/documentation/content/Taxonomy/zero-clutter-category.md @@ -5,7 +5,7 @@ layout: post Date: 2013-08-27 23:20 comments: false Slug: zero-clutter-categories -Category: Taxanomy +Category: Taxonomy --- Pelican by default creates a separate page for each category. Themes list all From 1c912e06ae4157236db1f78036a3189a6d05d33f Mon Sep 17 00:00:00 2001 From: Talha Mansoor <talha131@gmail.com> Date: Mon, 1 Jul 2019 17:24:15 +0500 Subject: [PATCH 29/52] ci(spellcheck): add words to the dictionary --- .yaspeller.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.yaspeller.json b/.yaspeller.json index ab8d8ef4..465933cd 100644 --- a/.yaspeller.json +++ b/.yaspeller.json @@ -63,6 +63,7 @@ "FontAwesome", "foss", "FreeLists", + "freelists", "fucking", "Gan", "Garamond", @@ -105,7 +106,7 @@ "Lin", "linuxabc", "MacBook", - "Mailchimp", + "mailchimp", "maintainer", "maintainers", "Makefile", From 27d8d57d9fa19ae4fb4d437e1b8c578b00c29a06 Mon Sep 17 00:00:00 2001 From: Talha Mansoor <talha131@gmail.com> Date: Wed, 3 Jul 2019 05:34:04 +0500 Subject: [PATCH 30/52] chore(seo): move Bing claim code to environment variables --- documentation/pelicanconf.py | 3 +-- documentation/publishconf.py | 2 ++ 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/documentation/pelicanconf.py b/documentation/pelicanconf.py index 04b7d4ee..23442e8c 100644 --- a/documentation/pelicanconf.py +++ b/documentation/pelicanconf.py @@ -69,8 +69,7 @@ ("RSS", SITEURL + "/feeds/all.atom.xml"), ) -CLAIM_GOOGLE = "Bk4Z5ucHLyPXqlZlj5LzANpYBBSvxqBW4E8i-Kwf-bQ" -CLAIM_BING = "8FF1B025212A47B5B27CC47163A042F0" +CLAIM_BING = "BC16AEBED17872F083B3E1E7A67454BD" # Elegant theme STATIC_PATHS = ["theme/images", "images", "extra/_redirects"] diff --git a/documentation/publishconf.py b/documentation/publishconf.py index d703cd88..2ef01816 100644 --- a/documentation/publishconf.py +++ b/documentation/publishconf.py @@ -16,6 +16,7 @@ SITEURL = "https://elegant.oncrashreboot.com" FEED_ALL_ATOM = "feeds/all.atom.xml" CATEGORY_FEED_ATOM = "feeds/{slug}.atom.xml" + CLAIM_BING = os.environ.get("CLAIM_BING_PROD") if os.environ.get("STAT_COUNTER_PROJECT_PROD") and os.environ.get( "STAT_COUNTER_SECURITY_PROD" @@ -29,6 +30,7 @@ SITESUBTITLE = "Pre Release Documentation of The Best Pelican Theme" SITEURL = "https://next.elegant.oncrashreboot.com" LANDING_PAGE_TITLE = "Elegant (Next) – Why it is the Best Pelican Theme" + if os.environ.get("STAT_COUNTER_PROJECT_NEXT") and os.environ.get( "STAT_COUNTER_SECURITY_NEXT" ): From 2302199a5f02950ebad0e83e72999fadd96727ed Mon Sep 17 00:00:00 2001 From: Talha Mansoor <talha131@gmail.com> Date: Wed, 3 Jul 2019 05:34:40 +0500 Subject: [PATCH 31/52] chore: remove redundant check --- documentation/publishconf.py | 20 ++++++-------------- 1 file changed, 6 insertions(+), 14 deletions(-) diff --git a/documentation/publishconf.py b/documentation/publishconf.py index 2ef01816..baa32e51 100644 --- a/documentation/publishconf.py +++ b/documentation/publishconf.py @@ -17,26 +17,18 @@ FEED_ALL_ATOM = "feeds/all.atom.xml" CATEGORY_FEED_ATOM = "feeds/{slug}.atom.xml" CLAIM_BING = os.environ.get("CLAIM_BING_PROD") - - if os.environ.get("STAT_COUNTER_PROJECT_PROD") and os.environ.get( - "STAT_COUNTER_SECURITY_PROD" - ): - STAT_COUNTER_PROJECT = os.environ.get("STAT_COUNTER_PROJECT_PROD") - STAT_COUNTER_SECURITY = os.environ.get("STAT_COUNTER_SECURITY_PROD") - GOOGLE_ANALYTICS = os.environ.get("GOOGLE_ANALYTICS_PROD") + STAT_COUNTER_PROJECT = os.environ.get("STAT_COUNTER_PROJECT_PROD") + STAT_COUNTER_SECURITY = os.environ.get("STAT_COUNTER_SECURITY_PROD") + GOOGLE_ANALYTICS = os.environ.get("GOOGLE_ANALYTICS_PROD") elif os.environ.get("CONTEXT") == "branch-deploy" and os.environ.get("HEAD") == "next": SITENAME = "Elegant (Next)" SITESUBTITLE = "Pre Release Documentation of The Best Pelican Theme" SITEURL = "https://next.elegant.oncrashreboot.com" LANDING_PAGE_TITLE = "Elegant (Next) – Why it is the Best Pelican Theme" - - if os.environ.get("STAT_COUNTER_PROJECT_NEXT") and os.environ.get( - "STAT_COUNTER_SECURITY_NEXT" - ): - STAT_COUNTER_PROJECT = os.environ.get("STAT_COUNTER_PROJECT_NEXT") - STAT_COUNTER_SECURITY = os.environ.get("STAT_COUNTER_SECURITY_NEXT") - GOOGLE_ANALYTICS = os.environ.get("GOOGLE_ANALYTICS_NEXT") + STAT_COUNTER_PROJECT = os.environ.get("STAT_COUNTER_PROJECT_NEXT") + STAT_COUNTER_SECURITY = os.environ.get("STAT_COUNTER_SECURITY_NEXT") + GOOGLE_ANALYTICS = os.environ.get("GOOGLE_ANALYTICS_NEXT") else: SITEURL = "" From 8dba24bf1cf3c8448c1dd7f6a99302e6e5eeb9e9 Mon Sep 17 00:00:00 2001 From: Talha Mansoor <talha131@gmail.com> Date: Wed, 3 Jul 2019 19:54:08 +0500 Subject: [PATCH 32/52] chore(docs): update projects list --- documentation/pelicanconf.py | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/documentation/pelicanconf.py b/documentation/pelicanconf.py index 23442e8c..9a0e4d73 100644 --- a/documentation/pelicanconf.py +++ b/documentation/pelicanconf.py @@ -123,11 +123,25 @@ "url": "https://github.com/Pelican-Elegant/elegant", "description": "Source code of Elegant theme", }, + { + "name": "Issue Tracker", + "url": "https://github.com/Pelican-Elegant/elegant/issues", + "description": "Give your feedback, ask questions or report issues", + }, + { + "name": "Roadmap", + "url": "https://github.com/Pelican-Elegant/elegant/milestones", + "description": "See planned features and estimated release dates", + }, + { + "name": "onCrashReboot", + "url": "https://www.oncrashreboot.com/", + "description": "Home page of Elegant creator and lead developer", + }, { "name": "Pelican", "url": "https://github.com/getpelican/pelican/", - "description": "Static site generator that supports Markdown and" - " reST syntax", + "description": "Static site generator that powers Elegant", }, { "name": "Pelican Plugins", From 0af30a8df03f1de56e3e6f541bd188c14d7303d5 Mon Sep 17 00:00:00 2001 From: Talha Mansoor <talha131@gmail.com> Date: Wed, 3 Jul 2019 20:05:18 +0500 Subject: [PATCH 33/52] docs(add): add help article on search Close #392 --- .../Elegant - Pelican Theme/elegant-theme.md | 28 ------------ documentation/content/Search/tipue-search.md | 43 +++++++++++++++++++ 2 files changed, 43 insertions(+), 28 deletions(-) create mode 100644 documentation/content/Search/tipue-search.md diff --git a/documentation/content/Elegant - Pelican Theme/elegant-theme.md b/documentation/content/Elegant - Pelican Theme/elegant-theme.md index f0c22e6c..29138b7c 100644 --- a/documentation/content/Elegant - Pelican Theme/elegant-theme.md +++ b/documentation/content/Elegant - Pelican Theme/elegant-theme.md @@ -13,34 +13,6 @@ keywords: pelican theme, responsive theme, tipue search What makes Elegant so special? -## Search - -Static sites usually do not offer search. Elegant uses [Tipue -Search](http://www.tipue.com/search/)- an open source jQuery plugin, to offer -search for your static site. - -There are two search modes. - -1. **JSON Mode** Your site pages will be stored in JSON at your server. Tipue - Search will use AJAX to access it and render search result. You need [Tipue - Search plugin](https://github.com/getpelican/pelican-plugins) to use this - mode. -1. **Live Mode Search** Tipue Search will fetch your site using Sitemap, index - it and store it in the visitor's cache. This mode requires [Sitemap - plugin](https://github.com/getpelican/pelican-plugins). - -Use JSON mode if you value speed, or have a large site, or don't want to -overwhelm your host server for every search query. - -Here is how the search result looks like - -![Search result for App Store]({static}/images/elegant-theme_search-result.png) - -Search box is part of main navigation menu so that visitor can search from any -page. - -![Search box]({static}/images/elegant-theme_search-box.png) - ## Custom 404 Page Elegant has a custom Error 404 page for your readers. diff --git a/documentation/content/Search/tipue-search.md b/documentation/content/Search/tipue-search.md new file mode 100644 index 00000000..80e90eed --- /dev/null +++ b/documentation/content/Search/tipue-search.md @@ -0,0 +1,43 @@ +--- +Title: Add Search to your Site +Tags: unique +Date: 2019-07-03 19:56 +Slug: add-tipue-search +Summary: Elegant lets you add search to your static site +Category: Search +--- + +Static sites usually do not offer search. Elegant uses [Tipue +Search](http://www.tipue.com/search/)- an open source jQuery plugin, to offer +search for your static site. + +There are two search modes. + +1. **JSON Mode** Your site pages will be stored in JSON at your server. Tipue + Search will use AJAX to access it and render search result. You need [Tipue + Search plugin](https://github.com/getpelican/pelican-plugins) to use this + mode. +1. **Live Mode Search** Tipue Search will fetch your site using Sitemap, index + it and store it in the visitor's cache. This mode requires [Sitemap + plugin](https://github.com/getpelican/pelican-plugins). + +Use JSON mode if you value speed, or have a large site, or don't want to +overwhelm your host server for every search query. + +Here is how the search result looks like + +![Search result for App Store]({static}/images/elegant-theme_search-result.png) + +Search box is part of main navigation menu so that visitor can search from any +page. + +![Search box]({static}/images/elegant-theme_search-box.png) + +## Configuration + +To enable search, you need to enable `tipue_search` plugin and add `search` to `DIRECT_TEMPLATES` in your pelican configuration + +```python +PLUGINS = [tipue_search'] +DIRECT_TEMPLATES = (('index', 'tags', 'categories','archives', 'search')) +``` From 37ae1b4c2ccbc560248c26328495f2c70b5726ed Mon Sep 17 00:00:00 2001 From: Talha Mansoor <talha131@gmail.com> Date: Wed, 3 Jul 2019 20:09:34 +0500 Subject: [PATCH 34/52] docs(update): remove note about two search modes We don't have the resources to support both. I have no idea if tipue supports the live mode anymore. --- documentation/content/Search/tipue-search.md | 13 ------------- 1 file changed, 13 deletions(-) diff --git a/documentation/content/Search/tipue-search.md b/documentation/content/Search/tipue-search.md index 80e90eed..1b68bfc0 100644 --- a/documentation/content/Search/tipue-search.md +++ b/documentation/content/Search/tipue-search.md @@ -11,19 +11,6 @@ Static sites usually do not offer search. Elegant uses [Tipue Search](http://www.tipue.com/search/)- an open source jQuery plugin, to offer search for your static site. -There are two search modes. - -1. **JSON Mode** Your site pages will be stored in JSON at your server. Tipue - Search will use AJAX to access it and render search result. You need [Tipue - Search plugin](https://github.com/getpelican/pelican-plugins) to use this - mode. -1. **Live Mode Search** Tipue Search will fetch your site using Sitemap, index - it and store it in the visitor's cache. This mode requires [Sitemap - plugin](https://github.com/getpelican/pelican-plugins). - -Use JSON mode if you value speed, or have a large site, or don't want to -overwhelm your host server for every search query. - Here is how the search result looks like ![Search result for App Store]({static}/images/elegant-theme_search-result.png) From d8c5ec3f6200fe39a51f6867086c75d519e3baec Mon Sep 17 00:00:00 2001 From: Talha Mansoor <talha131@gmail.com> Date: Wed, 3 Jul 2019 20:11:24 +0500 Subject: [PATCH 35/52] docs(add): add article on custom 404 page --- .../Elegant - Pelican Theme/elegant-theme.md | 6 ------ .../content/Extra Customization/custom-404.md | 18 ++++++++++++++++++ 2 files changed, 18 insertions(+), 6 deletions(-) create mode 100644 documentation/content/Extra Customization/custom-404.md diff --git a/documentation/content/Elegant - Pelican Theme/elegant-theme.md b/documentation/content/Elegant - Pelican Theme/elegant-theme.md index 29138b7c..155f5208 100644 --- a/documentation/content/Elegant - Pelican Theme/elegant-theme.md +++ b/documentation/content/Elegant - Pelican Theme/elegant-theme.md @@ -13,12 +13,6 @@ keywords: pelican theme, responsive theme, tipue search What makes Elegant so special? -## Custom 404 Page - -Elegant has a custom Error 404 page for your readers. - -![Error 404 page]({static}/images/elegant-theme_error-404-page.png) - --- ## Elegant - Technical Nitty-Gritty diff --git a/documentation/content/Extra Customization/custom-404.md b/documentation/content/Extra Customization/custom-404.md new file mode 100644 index 00000000..69cfc3ad --- /dev/null +++ b/documentation/content/Extra Customization/custom-404.md @@ -0,0 +1,18 @@ +--- +Title: Custom 404 Page +Tags: unique +Date: 2019-07-03 20:07 +Slug: custom-404-page +Summary: Elegant has a custom 404 page +Category: Extra Customization +--- + +Elegant has a custom Error 404 page for your readers. + +![Error 404 page]({static}/images/elegant-theme_error-404-page.png) + +To enable, add `404` to your `DIRECT_TEMPLATES` in pelican configuration. + +```python +DIRECT_TEMPLATES = (('index', 'tags', 'categories','archives', '404')) +``` From 8bb72056cff9baf3911da3233c9850df51a8bcdb Mon Sep 17 00:00:00 2001 From: Talha Mansoor <talha131@gmail.com> Date: Wed, 3 Jul 2019 20:17:48 +0500 Subject: [PATCH 36/52] docs(update): add article on customizing style --- .../customize-elegant.md | 46 ----------------- .../Extra Customization/custom-style.md | 51 +++++++++++++++++++ 2 files changed, 51 insertions(+), 46 deletions(-) create mode 100644 documentation/content/Extra Customization/custom-style.md diff --git a/documentation/content/Elegant - Pelican Theme/customize-elegant.md b/documentation/content/Elegant - Pelican Theme/customize-elegant.md index 34e35be0..5f36e6f2 100644 --- a/documentation/content/Elegant - Pelican Theme/customize-elegant.md +++ b/documentation/content/Elegant - Pelican Theme/customize-elegant.md @@ -19,52 +19,6 @@ practice will make upgrading Elegant fuss free process. Instead use following recommended ways. -# Customize Style - -To customize Elegant's visual style, use -[`custom.css`](https://github.com/Pelican-Elegant/elegant/blob/master/static/css/custom.css). -You can override Elegant's visual style like font, color, spacing etc using -this sheet. This empty style sheet is present at following path in your Elegant -folder, - - :::bash - static/css/custom.css - -Find the code of the element you want to customize in -[`elegant.css`](https://github.com/Pelican-Elegant/elegant/blob/master/static/css/elegant.css). -Copy the element's selector and styles, and paste it in `custom.css`. Edit this -CSS code and customize it to your liking. - -Your customizations will override whatever rules are defined in `elegant.css`. - -Let's take a look how you can change the style of hyperlinks in an article. -Following is the relevant code, - - :::css - article p:not(#list-of-translations):not(#post-share-links) a, - article ol a, - article div.article-content ul:not(.articles-timeline):not(.related-posts-list) a { - - border-bottom: thin dashed #A9A9A9; - color: #000; - } - -Copy and paste it in `custom.css`. Change color to red for example, - - :::css - article p:not(#list-of-translations):not(#post-share-links) a, - article ol a, - article div.article-content ul:not(.articles-timeline):not(.related-posts-list) a { - - border-bottom: thin dashed #A9A9A9; - color: red; - } - -Test your website using Pelican. All links should be colored red. - -Read [this post](avoid-unnecessary-http-requests) to make sure your site's page -speed does not decrease due to additional HTTP request. - # Change Syntax Highlight Theme Elegant uses [Solarized theme](http://ethanschoonover.com/solarized) for syntax diff --git a/documentation/content/Extra Customization/custom-style.md b/documentation/content/Extra Customization/custom-style.md new file mode 100644 index 00000000..1be07a21 --- /dev/null +++ b/documentation/content/Extra Customization/custom-style.md @@ -0,0 +1,51 @@ +--- +Title: Customize Style +Tags: unique +Date: 2019-07-03 20:14 +Slug: customize-style +Category: Extra Customization +--- + +To customize Elegant's visual style, use +[`custom.css`](https://github.com/Pelican-Elegant/elegant/blob/master/static/css/custom.css). +You can override Elegant's visual style like font, color, spacing etc using +this sheet. This empty style sheet is present at following path in your Elegant +folder, + + :::bash + static/css/custom.css + +Find the code of the element you want to customize in +[`elegant.css`](https://github.com/Pelican-Elegant/elegant/blob/master/static/css/elegant.css). +Copy the element's selector and styles, and paste it in `custom.css`. Edit this +CSS code and customize it to your liking. + +Your customizations will override whatever rules are defined in `elegant.css`. + +Let's take a look how you can change the style of hyperlinks in an article. +Following is the relevant code, + + :::css + article p:not(#list-of-translations):not(#post-share-links) a, + article ol a, + article div.article-content ul:not(.articles-timeline):not(.related-posts-list) a { + + border-bottom: thin dashed #A9A9A9; + color: #000; + } + +Copy and paste it in `custom.css`. Change color to red for example, + + :::css + article p:not(#list-of-translations):not(#post-share-links) a, + article ol a, + article div.article-content ul:not(.articles-timeline):not(.related-posts-list) a { + + border-bottom: thin dashed #A9A9A9; + color: red; + } + +Test your website using Pelican. All links should be colored red. + +Read [this post]({filename}../Supported Plugins/assets-plugin.md) to make sure your site's page +speed does not decrease due to additional HTTP request. From 16c1db3c969f89435eb019a95dbd32bbefeb9ae5 Mon Sep 17 00:00:00 2001 From: Talha Mansoor <talha131@gmail.com> Date: Wed, 3 Jul 2019 20:20:07 +0500 Subject: [PATCH 37/52] docs(add): add article on syntax theme --- .../customize-elegant.md | 16 -------------- .../custome-syntax-theme.md | 21 +++++++++++++++++++ 2 files changed, 21 insertions(+), 16 deletions(-) create mode 100644 documentation/content/Extra Customization/custome-syntax-theme.md diff --git a/documentation/content/Elegant - Pelican Theme/customize-elegant.md b/documentation/content/Elegant - Pelican Theme/customize-elegant.md index 5f36e6f2..014079ce 100644 --- a/documentation/content/Elegant - Pelican Theme/customize-elegant.md +++ b/documentation/content/Elegant - Pelican Theme/customize-elegant.md @@ -19,22 +19,6 @@ practice will make upgrading Elegant fuss free process. Instead use following recommended ways. -# Change Syntax Highlight Theme - -Elegant uses [Solarized theme](http://ethanschoonover.com/solarized) for syntax -highlighting. To replace it, copy contents of your preferred theme's CSS style -sheet into `custom.css`. - -Alternatively, you can replace contents of `pygments.css` with your theme's -style sheet. - -If you feel like experimenting with different themes then [this -repository](https://github.com/uraimo/pygments-vimstyles) has Pygments CSS of -Vim themes. [This one](https://github.com/richleland/pygments-css) has Pygments -CSS of built-in styles. Do not forget to change `.codehilite` CSS class -identifier to `.highlight`. Code blocks in Pelican generated HTML use -`.highlight` class. - # Change Labels It is quite possible you will feel the need to tweak labels of different diff --git a/documentation/content/Extra Customization/custome-syntax-theme.md b/documentation/content/Extra Customization/custome-syntax-theme.md new file mode 100644 index 00000000..5deeb9a5 --- /dev/null +++ b/documentation/content/Extra Customization/custome-syntax-theme.md @@ -0,0 +1,21 @@ +--- +Title: Change Syntax Highlight Theme +Tags: unique +Date: 2019-07-03 20:18 +Slug: change-syntax-highlight-theme +Category: Extra Customization +--- + +Elegant uses [Solarized theme](http://ethanschoonover.com/solarized) for syntax +highlighting. To replace it, copy contents of your preferred theme's CSS style +sheet into `custom.css`. + +Alternatively, you can replace contents of `pygments.css` with your theme's +style sheet. + +If you feel like experimenting with different themes then [this +repository](https://github.com/uraimo/pygments-vimstyles) has Pygments CSS of +Vim themes. [This one](https://github.com/richleland/pygments-css) has Pygments +CSS of built-in styles. Do not forget to change `.codehilite` CSS class +identifier to `.highlight`. Code blocks in Pelican generated HTML use +`.highlight` class. From 5713b3a9a86ddb32e101f228bb502057f70fc995 Mon Sep 17 00:00:00 2001 From: Talha Mansoor <talha131@gmail.com> Date: Wed, 3 Jul 2019 20:24:40 +0500 Subject: [PATCH 38/52] docs(update): change category --- .../social-profiles-sidebar.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename documentation/content/{Building Readership => SEO and SMO}/social-profiles-sidebar.md (99%) diff --git a/documentation/content/Building Readership/social-profiles-sidebar.md b/documentation/content/SEO and SMO/social-profiles-sidebar.md similarity index 99% rename from documentation/content/Building Readership/social-profiles-sidebar.md rename to documentation/content/SEO and SMO/social-profiles-sidebar.md index f972b034..04fc8703 100644 --- a/documentation/content/Building Readership/social-profiles-sidebar.md +++ b/documentation/content/SEO and SMO/social-profiles-sidebar.md @@ -1,6 +1,6 @@ Title: How to display your Social Media Profiles Tags: pelican-theme, font-awesome, social-media, web-design -Category: Building Readership +Category: SEO & SMO Date: 2014-01-27 00:28 Slug: how-to-display-your-social-media-profiles Disqus_identifier: k7fpj4y-how-to-display-your-social-media-profiles From 067f42eb279f4276c28635ec90e1dcaff45d64ec Mon Sep 17 00:00:00 2001 From: Talha Mansoor <talha131@gmail.com> Date: Wed, 3 Jul 2019 20:25:11 +0500 Subject: [PATCH 39/52] docs(add): article on changing labels --- .../customize-elegant.md | 41 ----------------- .../Extra Customization/change-labels.md | 46 +++++++++++++++++++ 2 files changed, 46 insertions(+), 41 deletions(-) create mode 100644 documentation/content/Extra Customization/change-labels.md diff --git a/documentation/content/Elegant - Pelican Theme/customize-elegant.md b/documentation/content/Elegant - Pelican Theme/customize-elegant.md index 014079ce..b07cd93c 100644 --- a/documentation/content/Elegant - Pelican Theme/customize-elegant.md +++ b/documentation/content/Elegant - Pelican Theme/customize-elegant.md @@ -18,44 +18,3 @@ project. Do not edit template files, JavaScript code and style sheets. This practice will make upgrading Elegant fuss free process. Instead use following recommended ways. - -# Change Labels - -It is quite possible you will feel the need to tweak labels of different -sections or widgets. For example, change label of [social -widget](/how-to-display-your-social-media-profiles) from "Contact" to "Stay in -Touch". - -Don't worry! We got you covered! - -Elegant has all the customizable variables in one place. [`_defaults.html` -file](https://github.com/Pelican-Elegant/elegant/blob/master/templates/_includes/_defaults.html). - - :::bash - templates/_includes/_defaults.html - -Let's see how can we change social widget label. - - #!jinja - {# Label for the list of social profiles #} - {% if not SOCIAL_PROFILE_LABEL %} - {% set SOCIAL_PROFILE_LABEL = 'Contact' %} - {% else %} - {% set SOCIAL_PROFILE_LABEL = SOCIAL_PROFILE_LABEL %} - {% endif %} - -Line 1, text enclosed in `{# #}` is a comment, which says this section is about -"Label for the list of social profiles". - -The text in all capital case `SOCIAL_PROFILE_LABEL` is the actual variable. - -Line 3 says `SOCIAL_PROFILE_LABEL` is set to `Contact`. - -To change this value, assign it a different value in your Pelican -configuration, `pelicanconf.py`. - - :::python - SOCIAL_PROFILE_LABEL = 'Stay in Touch' - -That's it. The title of social widget will change. There are several others -labels that you can customize easily without touching Elegant's source code. diff --git a/documentation/content/Extra Customization/change-labels.md b/documentation/content/Extra Customization/change-labels.md new file mode 100644 index 00000000..35c5241b --- /dev/null +++ b/documentation/content/Extra Customization/change-labels.md @@ -0,0 +1,46 @@ +--- +Title: Change Labels +Tags: unique +Date: 2019-07-03 20:20 +Slug: change-labels +Category: Extra Customization +--- + +It is quite possible you will feel the need to tweak labels of different +sections or widgets. For example, change label of [social +widget](/how-to-display-your-social-media-profiles) from "Contact" to "Stay in +Touch". + +Don't worry! We got you covered! + +Elegant has all the customizable variables in one place. [`_defaults.html` +file](https://github.com/Pelican-Elegant/elegant/blob/master/templates/_includes/_defaults.html). + + :::bash + templates/_includes/_defaults.html + +Let's see how can we change social widget label. + + #!jinja + {# Label for the list of social profiles #} + {% if not SOCIAL_PROFILE_LABEL %} + {% set SOCIAL_PROFILE_LABEL = 'Contact' %} + {% else %} + {% set SOCIAL_PROFILE_LABEL = SOCIAL_PROFILE_LABEL %} + {% endif %} + +Line 1, text enclosed in `{# #}` is a comment, which says this section is about +"Label for the list of social profiles". + +The text in all capital case `SOCIAL_PROFILE_LABEL` is the actual variable. + +Line 3 says `SOCIAL_PROFILE_LABEL` is set to `Contact`. + +To change this value, assign it a different value in your Pelican +configuration, `pelicanconf.py`. + + :::python + SOCIAL_PROFILE_LABEL = 'Stay in Touch' + +That's it. The title of social widget will change. There are several others +labels that you can customize easily without touching Elegant's source code. From 8786535a99be86ec9c29821966c53a2bcad92467 Mon Sep 17 00:00:00 2001 From: Talha Mansoor <talha131@gmail.com> Date: Wed, 3 Jul 2019 20:26:31 +0500 Subject: [PATCH 40/52] docs(update): change category --- .../content/{Building Readership => SEO and SMO}/rss-feeds.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename documentation/content/{Building Readership => SEO and SMO}/rss-feeds.md (98%) diff --git a/documentation/content/Building Readership/rss-feeds.md b/documentation/content/SEO and SMO/rss-feeds.md similarity index 98% rename from documentation/content/Building Readership/rss-feeds.md rename to documentation/content/SEO and SMO/rss-feeds.md index e47a4149..022022dd 100644 --- a/documentation/content/Building Readership/rss-feeds.md +++ b/documentation/content/SEO and SMO/rss-feeds.md @@ -1,6 +1,6 @@ Title: How to show RSS feeds icon Tags: pelican-theme, font-awesome, web-design -Category: Building Readership +Category: SEO & SMO Date: 2014-03-17 15:28 Slug: how-to-show-rss-feeds-icon Disqus_identifier: ijvxwtg-how-to-show-rss-feeds-icon From 784a5fac84c1b5b7712f1070cba872164d2a06ad Mon Sep 17 00:00:00 2001 From: Talha Mansoor <talha131@gmail.com> Date: Wed, 3 Jul 2019 20:34:31 +0500 Subject: [PATCH 41/52] docs(update): how to customize elegant --- .../customize-elegant.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) rename documentation/content/{Elegant - Pelican Theme => Extra Customization}/customize-elegant.md (79%) diff --git a/documentation/content/Elegant - Pelican Theme/customize-elegant.md b/documentation/content/Extra Customization/customize-elegant.md similarity index 79% rename from documentation/content/Elegant - Pelican Theme/customize-elegant.md rename to documentation/content/Extra Customization/customize-elegant.md index b07cd93c..a90ac00e 100644 --- a/documentation/content/Elegant - Pelican Theme/customize-elegant.md +++ b/documentation/content/Extra Customization/customize-elegant.md @@ -1,6 +1,6 @@ Title: How to Customize Elegant -Tags: pelican-theme, config -Category: Elegant - Pelican Theme +Tags: config +Category: Extra Customization Date: 2014-03-24 14:05 Slug: how-to-customize-elegant Disqus_identifier: ale31i7-how-to-customize-elegant @@ -17,4 +17,4 @@ Elegant is best maintained when you treat it as a separate resource in your project. Do not edit template files, JavaScript code and style sheets. This practice will make upgrading Elegant fuss free process. -Instead use following recommended ways. +Instead see the guides in ["Extra Customization" category](categories.html#extra-customization-ref). From 033e0e126a8f7b3e5bfafc5dbca2e6cc2a4f53fe Mon Sep 17 00:00:00 2001 From: Talha Mansoor <talha131@gmail.com> Date: Wed, 3 Jul 2019 20:43:34 +0500 Subject: [PATCH 42/52] docs(update): change category --- .../custome-syntax-theme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename documentation/content/{Extra Customization => Code Snippets}/custome-syntax-theme.md (96%) diff --git a/documentation/content/Extra Customization/custome-syntax-theme.md b/documentation/content/Code Snippets/custome-syntax-theme.md similarity index 96% rename from documentation/content/Extra Customization/custome-syntax-theme.md rename to documentation/content/Code Snippets/custome-syntax-theme.md index 5deeb9a5..8b8d9358 100644 --- a/documentation/content/Extra Customization/custome-syntax-theme.md +++ b/documentation/content/Code Snippets/custome-syntax-theme.md @@ -3,7 +3,7 @@ Title: Change Syntax Highlight Theme Tags: unique Date: 2019-07-03 20:18 Slug: change-syntax-highlight-theme -Category: Extra Customization +Category: Code Snippets --- Elegant uses [Solarized theme](http://ethanschoonover.com/solarized) for syntax From 776e36f19f3bcd5c9d5790b50e49f03a39d49fc2 Mon Sep 17 00:00:00 2001 From: Talha Mansoor <talha131@gmail.com> Date: Wed, 3 Jul 2019 20:52:44 +0500 Subject: [PATCH 43/52] docs(add): metadata variables --- .../content/Extra Customization/meta-data.md | 33 +++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 documentation/content/Extra Customization/meta-data.md diff --git a/documentation/content/Extra Customization/meta-data.md b/documentation/content/Extra Customization/meta-data.md new file mode 100644 index 00000000..e9d08240 --- /dev/null +++ b/documentation/content/Extra Customization/meta-data.md @@ -0,0 +1,33 @@ +--- +Title: Metadata +Tags: unique +Date: 2019-07-03 20:44 +Slug: metadata +Category: Extra Customization +--- + +Pelican uses [file +metadata](http://docs.getpelican.com/en/latest/getting_started.html#file-metadata) +from your articles and pages text files to get information about your posts, +like tags, authors etc. + +On top of _"official"_ metadata, Elegant uses some optional metadata that you +can use in your articles and pages. + +1. `summary` used for [Search Engine + Optimization](search-engine-and-social-media-optimization#search-engine-optimization-seo) +1. `subtitle` used to set [article + subtitle]({filename}../Appearance and Style/article-subtitle.md) +1. `keywords` used for [Search Engine + Optimization](search-engine-and-social-media-optimization#search-engine-optimization-seo) +1. `modified` used to set [last updated time](how-does-modified-metadata-works) + of the article +1. `series_title` used with [`multi_part` plugin](how-to-use-multi-part-plugin) +1. `featured_image` used for [Social Media + Optimization](search-engine-and-social-media-optimization#social-media-optimization-smo) +1. `share_post_intro` used with [`share_post` + plugin](how-to-use-social-sharing-plugin) +1. `comments_intro` used with + [comments]({filename}../Comments/invite-comments.md) +1. `comment_id` used with + [comments]({filename}../Comments/comment-id.md) From 0137fe893eddb1f60c0f428b9b44d1bba59f12b8 Mon Sep 17 00:00:00 2001 From: Talha Mansoor <talha131@gmail.com> Date: Wed, 3 Jul 2019 20:53:08 +0500 Subject: [PATCH 44/52] docs(update): remove article It has been extracted into different new articles --- .../configuration-variables.md | 103 ------------------ 1 file changed, 103 deletions(-) delete mode 100644 documentation/content/Elegant - Pelican Theme/configuration-variables.md diff --git a/documentation/content/Elegant - Pelican Theme/configuration-variables.md b/documentation/content/Elegant - Pelican Theme/configuration-variables.md deleted file mode 100644 index cb111f7e..00000000 --- a/documentation/content/Elegant - Pelican Theme/configuration-variables.md +++ /dev/null @@ -1,103 +0,0 @@ -Title: Configuration Variables and Metadata List -Tags: pelican-theme, config -Category: Elegant - Pelican Theme -Date: 2014-04-23 18:25 -Slug: configuration-variables-and-metadata-list -Disqus_identifier: dexlwa8-configuration-variables-and-metadata-list -Subtitle: -Summary: List of all the configuration variables and metadata that you can use with Elegant -Keywords: - -[TOC] - -## Pelican Configuration - -These are the settings that will help you get the most out of Elegant - - #!python - TAG_SAVE_AS = '' - AUTHOR_SAVE_AS = '' - CATEGORY_SAVE_AS = '' - STATIC_PATHS = ['theme/images', 'images'] - PLUGINS = ['sitemap', 'extract_toc', 'tipue_search', - 'neighbors', 'assets', 'share_post'] - MD_EXTENSIONS = ['codehilite(css_class=highlight)', 'extra', - 'headerid', 'toc(permalink=true)'] - DIRECT_TEMPLATES = (('index', 'tags', 'categories','archives', 'search', '404')) - -## Configuration Variables - -These are the optional configuration variables that you can define - -1. `PROJECTS` used for [Projects - feature](elegant-best-pelican-theme-features#projects) - on the landing page -1. `USE_SHORTCUT_ICONS` used for [shortcut icons like favicon, Opera Speed - Dial](how-to-set-shortcut-icons) -1. `SITE_LICENSE` used to add [site - license](few-more-features-of-elegant#add-license-to-your-site) -1. `SITE_SUBTITLE` used to add [site subtitle in the - footer](few-more-features-of-elegant#site-subtitle) -1. `COMMENTS_INTRO` used with - [comments](how-to-use-disqus-comments-elegantly#invite-visitors-to-comment) -1. `SITE_DESCRIPTION` used for [Search Engine - Optimization](search-engine-and-social-media-optimization#search-engine-optimization-seo) -1. `SOCIAL_PROFILE_LABEL` used with [social media profiles - widget](how-to-display-your-social-media-profiles) -1. `RECENT_ARTICLES_COUNT` see the post [Recent - Articles](elegant-best-pelican-theme-features#recent-articles) - -These are the variables used for [Mailchimp subscriber -form](elegant-best-pelican-theme-features#mailchimp) in the sidebar, - -1. `MAILCHIMP_FORM_ACTION` is mandatory. Set it to your Mailchimp form action - URL -1. `SUBSCRIBE_BUTTON_TITLE` -1. `EMAIL_FIELD_PLACEHOLDER` -1. `EMAIL_SUBSCRIPTION_LABEL` - -These are the variables used with different Pelican plugins, - -1. `SERIES_TITLE` used with [`multi_part` plugin](how-to-use-multi-part-plugin) -1. `SHARE_POST_INTRO` used with [`share_post` - plugin](how-to-use-social-sharing-plugin) -1. `RELATED_POSTS_LABEL` used with [`related_posts` - plugin](https://github.com/getpelican/pelican-plugins/tree/master/related_posts) - -These are the variables used for [Social Media -Optimization](search-engine-and-social-media-optimization#social-media-optimization-smo), - -1. `FEATURED_IMAGE` -1. `TWITTER_USERNAME` - -This site uses Elegant theme. You -can view its configuration files at -[Github](https://github.com/Pelican-Elegant/documentation) for inspiration. - -## Metadata - -Pelican uses [file -metadata](http://docs.getpelican.com/en/latest/getting_started.html#file-metadata) -from your articles and pages text files to get information about your posts, -like tags, authors etc. - -On top of _"official"_ metadata, Elegant uses some optional metadata that you -can use in your articles and pages. - -1. `summary` used for [Search Engine - Optimization](search-engine-and-social-media-optimization#search-engine-optimization-seo) -1. `subtitle` used to set [article - subtitle](elegant-best-pelican-theme-features#article-subtitle) -1. `keywords` used for [Search Engine - Optimization](search-engine-and-social-media-optimization#search-engine-optimization-seo) -1. `modified` used to set [last updated time](how-does-modified-metadata-works) - of the article -1. `series_title` used with [`multi_part` plugin](how-to-use-multi-part-plugin) -1. `featured_image` used for [Social Media - Optimization](search-engine-and-social-media-optimization#social-media-optimization-smo) -1. `comments_intro` used with - [comments](how-to-use-disqus-comments-elegantly#invite-visitors-to-comment) -1. `share_post_intro` used with [`share_post` - plugin](how-to-use-social-sharing-plugin) -1. `disqus_identifier` used with - [comments](how-to-use-disqus-comments-elegantly#disqus-thread-id) From 53981619c41b321abb68509e18610493d76cf2a9 Mon Sep 17 00:00:00 2001 From: Talha Mansoor <talha131@gmail.com> Date: Wed, 3 Jul 2019 21:02:43 +0500 Subject: [PATCH 45/52] docs(uodate): remove outdated article --- .../Elegant - Pelican Theme/elegant-theme.md | 53 ------------------- 1 file changed, 53 deletions(-) delete mode 100644 documentation/content/Elegant - Pelican Theme/elegant-theme.md diff --git a/documentation/content/Elegant - Pelican Theme/elegant-theme.md b/documentation/content/Elegant - Pelican Theme/elegant-theme.md deleted file mode 100644 index 155f5208..00000000 --- a/documentation/content/Elegant - Pelican Theme/elegant-theme.md +++ /dev/null @@ -1,53 +0,0 @@ -Title: Elegant -Subtitle: Why it is the best Pelican theme -Date: 2013-08-27 23:20 -Category: Elegant - Pelican Theme -Tags: jinja2, bootstrap, pelican-theme, font-awesome -Summary: Elegant is a minimal, stylish and responsive Pelican theme. Its unique features are search, Mailchimp, twitter card, and custom 404 page. -Slug: elegant-best-pelican-theme-features -comment_id: 2189d14-elegant-a-theme-for-pelican -modified: 2013-10-11 23:00 -keywords: pelican theme, responsive theme, tipue search - -[TOC] - -What makes Elegant so special? - ---- - -## Elegant - Technical Nitty-Gritty - -### License - -The license requires that you give credit to me, Talha Mansoor, as the author -of the Elegant theme on every site that uses this theme. I have placed the -attribution in the footer of every page. Do not remove it. If you need to -remove or change the style of the attribution, please get in [touch with -me](http://oncrashreboot.com/#about-me) first. - -Along with this attribution clause, Elegant theme is licensed under The MIT -License. - -If you use my theme, I would love to hear from you. [Get in -touch](http://oncrashreboot.com/#about-me) and let me know about it. I may link -to your site too. - -### Contribute - -Front end design is not my strong suite. I must have made some blunders in this -design unknowingly. Please don't let me go away with buggy code. - -- File bugs at [Github - issues](https://github.com/Pelican-Elegant/elegant/issues) -- Share your ideas about the design in the comments below -- And most of all contribute improvements to [this - project](https://github.com/Pelican-Elegant/elegant/) - -There are two problem areas that I can think of, - -1. Internet Explorer support -1. Web safe fonts. I developed this theme on a MacBook Retina. Although I have - tried to make sure it looks great on all platforms but it still needs polish - -Besides these, there must be other bugs that I haven't noticed yet. I need your -help to hunt them down and make them behave. From 1684b00994830320f2b23460e46342a8cd8ca60e Mon Sep 17 00:00:00 2001 From: Talha Mansoor <talha131@gmail.com> Date: Wed, 3 Jul 2019 21:49:14 +0500 Subject: [PATCH 46/52] docs(add): invitation to participate --- .../content/Contributing/inviation.md | 22 +++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 documentation/content/Contributing/inviation.md diff --git a/documentation/content/Contributing/inviation.md b/documentation/content/Contributing/inviation.md new file mode 100644 index 00000000..d36bd858 --- /dev/null +++ b/documentation/content/Contributing/inviation.md @@ -0,0 +1,22 @@ +--- +Title: Invitation to participate +Date: 2019-07-03 20:07 +Slug: invitation-to-participate +Category: Contributing +--- + +Our brand new documentation website [elegant.onCrashReboot.com][elegant-home] is a great demo for the theme. + +If you like the theme and would like to contribute to Elegant, you are most welcome to do so. Even though Pelican is written in Python, no coding skills are needed to help out with Elegant, as themes consist mostly of [Jinja][] templates, CSS and HTML. It is honestly very easily to get into. + +If you want to help out, but have no idea where to start, we keep a list of [low-priority features that are just waiting for you to pick up][pr_welcome]. + +Another way to contribute is to help with the [documentation][docs]. We are keeping a list of [good first issues][docs_first] for newbies to get involved – these are easy to tackle, but in no way less helpful. + +And, of course, reporting bugs and filing feature requests to further improve Elegant (and its documentation), is also welcome. + +[jinja]: http://jinja.pocoo.org/ +[pr_welcome]: https://github.com/Pelican-Elegant/elegant/labels/pull%20request%20welcome +[docs]: https://github.com/Pelican-Elegant/elegant/tree/master/documentation +[docs_first]: https://github.com/Pelican-Elegant/elegant/issues?q=is%3Aopen+is%3Aissue+label%3A%22project+documentation%22 +[elegant-home]: https://elegant.oncrashreboot.com From eee29e7c70f9219417ed01b8183b7e13bf7d527f Mon Sep 17 00:00:00 2001 From: Talha Mansoor <talha131@gmail.com> Date: Wed, 3 Jul 2019 21:53:35 +0500 Subject: [PATCH 47/52] docs(update): change category --- .../{Announcements => Contributing}/community-driven-project.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename documentation/content/{Announcements => Contributing}/community-driven-project.md (99%) diff --git a/documentation/content/Announcements/community-driven-project.md b/documentation/content/Contributing/community-driven-project.md similarity index 99% rename from documentation/content/Announcements/community-driven-project.md rename to documentation/content/Contributing/community-driven-project.md index b287e30d..998255bf 100644 --- a/documentation/content/Announcements/community-driven-project.md +++ b/documentation/content/Contributing/community-driven-project.md @@ -1,7 +1,7 @@ --- Title: Elegant grows into a community-led project Tags: project-management -Category: Announcements +Category: Contributing Date: 2019-01-05 19:40 Slug: community-led-project Subtitle: The beginning of a beautiful friendship From 7504c11a4e2d801e642d09be6270d59856fed662 Mon Sep 17 00:00:00 2001 From: Talha Mansoor <talha131@gmail.com> Date: Wed, 3 Jul 2019 22:13:54 +0500 Subject: [PATCH 48/52] docs(add): add documentation for code contributions --- CONTRIBUTING.md | 112 +----------------- .../content/Contributing/beginners-guide.md | 72 +++++++++++ .../Contributing/contributing-license.md | 15 +++ documentation/content/pages/contribute.md | 25 ---- 4 files changed, 89 insertions(+), 135 deletions(-) create mode 100644 documentation/content/Contributing/beginners-guide.md create mode 100644 documentation/content/Contributing/contributing-license.md delete mode 100644 documentation/content/pages/contribute.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 33c536a3..f89bafd7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,111 +1,3 @@ -# Where do I start? +See our documentation at following link -Developing Elegant is a community effort, so you are very welcome to help develop it further into the most elegant theme out there. - -The main repository of Elegant is on [GitHub][elegant], which you may fork and then submit pull requests to, in order for them to be merged. - -If you found any issues, or have ideas how to improve the theme, please submit an [issue]. - -Also see issues tagged as [Pull Request Welcome](https://github.com/Pelican-Elegant/elegant/labels/pull%20request%20welcome) – these are issues that are not directly on our roadmap, but if you have time to contribute, we would be very glad to review and accept your pull request. - -If you want to contribute to documentation instead, do so in the [documentation repository][documentation]. Some easy tasks to tackle there are tagged as [Good First Issue](https://github.com/Pelican-Elegant/documentation/labels/good%20first%20issue) - -# Contributing Code - -1. Create a new git branch specific to your changes, instead of making your commits in the master branch. For example, create a branch `fix-issue-119` and add commits to it that fix “issue 119”. -2. Update the [CHANGELOG] -3. Create pull request from your fix branch, say `fix-issue-119`, against `next` branch of Elegant. (We use `master` branch to make new releases. `next` is used for development.) -4. Each pull request should only have a single feature or fix. Do not add multiple features or bug fixes to the same pull request. -5. Squash your commits to reduce noise from commit history. Use your better judgement to decide which commits should stay in the commit history, or consult project maintainers if confused. -6. Have (at least) one other active contributor review your code. -7. Once at least one code reviewer has approved it, it will can be merged. - -## Git Tips for Newcomers - -Here are some tips on how to make your life with Git easier when contributing. - -### How To Set Up Your Git - -1. Create a fork of the [Elegant repository][elegant] by clicking on the “Fork” button. -2. Clone your fork to your computer by clicking on the “Clone or download” button and following the instructions there. -3. When in the Git repository of your fork, run the following command to set the main repository as the upstream: `git remote add upstream https://github.com/Pelican-Elegant/pelican-elegant.git` - -### Updating/Rebasing to Upstream - -Occasionally – often before a pull request is able to be merged – you will need to update your own (fork) repository to the upstream (i.e. [Elegant][elegant]) development (i.e. `next`) branch. This can be done as follows: - -1. `git fetch upstream next` -2. `git rebase upstream/next` - -### Squash Commits & More Complex Rebasing - -When creating a pull request in GitHub, you have the option to squash all commits, but sometimes you need to fix either the mess you made or some clashes that prevent a merge of the two branches. - -In both cases, the following command is your Swiss-army knife: - -`git rebase --interactive upstream/master` - -For more on the interactive rebase command of Git, see [its official documentation][git_rebase]. - -[git_rebase]: https://git-scm.com/docs/user-manual#interactive-rebase - -# New Features and Styles - -If you plan to add new features to the theme, please make sure that: - -- you set sensible defaults so the theme works out of the box, without forcing the user to set any variable -- your changes do not negatively effect readability and reading experience -- your changes do not cause distraction for the reader -- any bigger features should go through the voting process (see below) - -# Code style - -Please make sure to follow the code style of the existing code base. - -Specifically: - -## Code/Template Formatting Rules - -- use single (`''`) rather than double (`""`) quotation marks for Jinja strings -- in Jinja print statements, surround the variable with spaces inside curly braces – for example: `{{ foo.bar }}` -- use double (`""`) quotation marks around HTML attributes -- end files with a newline - -## CSS Formatting Rules - -- font name’s first letter should be capital -- add a space after comma -- declarations should be sorted alphabetically -- use a single space between the last selector and the opening brace that begins the declaration block -- group together related classes and identities -- add a space after colon -- remove leading 0s -- remove unit specification after 0 values -- use three-digit Hex notation for colors wherever possible -- use hyphen `-` instead of underscore `_` in class and identity names - -Refer to [Google's HTML/CSS Style Guide][google_style_guide] for all other formatting rules. - -# Voting Process - -Any new features, bigger changes, decisions on what should constitute the next milestone or wider goals etc. should go through a vote, as follows. - -1. Open a new issue to describe it and to kick-start a discussion. -1. As soon as a suggestion (or several) are set in place, set a deadline, no shorter than 10 days. Also at this stage tag the issue with the “vote” label. -1. People can vote with the :+1: and :-1: emoji on individual suggestions. Anyone may cast votes for as many suggestions as they want. -1. At the end of the deadline, the suggestion with most votes (= № of :+1: - № of :-1:) is taken. - -# Licensing (Inbound=Outbound) - -All contributions will be understood to be made under the same (inbound) license as the main (outbound) license of the repository it is being contributed to – so [MIT License][] for all [code/theme][elegant] contributions, and [CC-BY-SA-3.0][] for all [documentation][] contributions. - -If you are contributing code that is not yours, make sure to indicate where you got the code from (and who the author/copyright holder is) and what license you got it under. - -[cc-by-sa-3.0]: https://spdx.org/licenses/CC-BY-SA-3.0.html -[changelog]: https://github.com/Pelican-Elegant/elegant/blob/master/CHANGELOG.md -[contributing]: ./CONTRIBUTING.md -[documentation]: https://github.com/Pelican-Elegant/documentation -[elegant]: https://github.com/Pelican-Elegant/elegant -[google_style_guide]: https://google.github.io/styleguide/htmlcssguide.html -[issue]: https://github.com/Pelican-Elegant/elegant/issues/ -[mit license]: https://spdx.org/licenses/MIT.html +http://localhost:9000/categories.html#contributing-ref diff --git a/documentation/content/Contributing/beginners-guide.md b/documentation/content/Contributing/beginners-guide.md new file mode 100644 index 00000000..4213b7d9 --- /dev/null +++ b/documentation/content/Contributing/beginners-guide.md @@ -0,0 +1,72 @@ +--- +Title: Git Tips for Beginners +Date: 2019-07-03 21:57 +Slug: git-tips-for-beginners +Category: Contributing +--- + +Here are some tips on how to make your life with Git easier when contributing. + +## How To Set Up Your Git + +1. Create a fork of the [Elegant repository][elegant] by clicking on the “Fork” button. +2. Clone your fork to your computer by clicking on the “Clone or download” button and following the instructions there. +3. When in the Git repository of your fork, run the following command to set the main repository as the upstream: `git remote add upstream https://github.com/Pelican-Elegant/pelican-elegant.git` + +## Updating/Rebasing to Upstream + +Occasionally – often before a pull request is able to be merged – you will need to update your own (fork) repository to the upstream (i.e. [Elegant][elegant]) development (i.e. `next`) branch. This can be done as follows: + +1. `git fetch upstream next` +2. `git rebase upstream/next` + +## Squash Commits & More Complex Rebasing + +When creating a pull request in GitHub, you have the option to squash all commits, but sometimes you need to fix either the mess you made or some clashes that prevent a merge of the two branches. + +In both cases, the following command is your Swiss-army knife: + +`git rebase --interactive upstream/master` + +For more on the interactive rebase command of Git, see [its official documentation][git_rebase]. + +[git_rebase]: https://git-scm.com/docs/user-manual#interactive-rebase + +# New Features and Styles + +If you plan to add new features to the theme, please make sure that: + +- you set sensible defaults so the theme works out of the box, without forcing the user to set any variable +- your changes do not negatively effect readability and reading experience +- your changes do not cause distraction for the reader +- any bigger features should go through the voting process (see below) + +# Code style + +Please make sure to follow the code style of the existing code base. + +Specifically: + +## Code/Template Formatting Rules + +- use single (`''`) rather than double (`""`) quotation marks for Jinja strings +- in Jinja print statements, surround the variable with spaces inside curly braces – for example: `{{ foo.bar }}` +- use double (`""`) quotation marks around HTML attributes +- end files with a newline + +## CSS Formatting Rules + +- font name’s first letter should be capital +- add a space after comma +- declarations should be sorted alphabetically +- use a single space between the last selector and the opening brace that begins the declaration block +- group together related classes and identities +- add a space after colon +- remove leading 0s +- remove unit specification after 0 values +- use three-digit Hex notation for colors wherever possible +- use hyphen `-` instead of underscore `_` in class and identity names + +Refer to [Google's HTML/CSS Style Guide][google_style_guide] for all other formatting rules. + +[elegant]: https://github.com/Pelican-Elegant/elegant diff --git a/documentation/content/Contributing/contributing-license.md b/documentation/content/Contributing/contributing-license.md new file mode 100644 index 00000000..26971d18 --- /dev/null +++ b/documentation/content/Contributing/contributing-license.md @@ -0,0 +1,15 @@ +--- +Title: Contributions Licesne +Date: 2019-07-03 22:07 +Slug: contribution-license +Category: Contributing +--- + +All contributions will be understood to be made under the same (inbound) license as the main (outbound) license of the repository it is being contributed to – so [MIT License][] for all code/theme contributions, and [CC-BY-SA-3.0][] for all documentation contributions. + +If you are contributing code that is not yours, make sure to indicate where you got the code from (and who the author/copyright holder is) and what license you got it under. + +[cc-by-sa-3.0]: https://spdx.org/licenses/CC-BY-SA-3.0.html +[documentation]: https://github.com/Pelican-Elegant/documentation +[elegant]: https://github.com/Pelican-Elegant/elegant +[mit license]: https://spdx.org/licenses/MIT.html diff --git a/documentation/content/pages/contribute.md b/documentation/content/pages/contribute.md deleted file mode 100644 index eb5fab72..00000000 --- a/documentation/content/pages/contribute.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -author: Pablo Iranzo Gómez (pablo.iranzo@gmail.com) -title: Contribute -tags: elegant, contribute -layout: page -date: 2019-01-14 7:30:47 +0100 -comments: true -category: Development -description: ---- - -[Elegant](https://github.com/Pelican-Elegant/elegant) is a feature rich-theme, driven by it's users. - -Contributing to the theme comes in different and all equally valuable ways - -- [Feedback (Bug reports, enhancement requests, etc)](https://github.com/pelican-elegant/elegant/issues/) -- [Documentation feedback/improvements/examples](https://github.com/pelican-elegant/documentation/issues/) -- Feature creation via Pull Requests on open issues -- Pull Request reviews, to comment on approach, code cleanup, etc - -Even a little feature that you might be missing, could be a big impact to other users that might not even have considered it before, so... - -Speak your mind or put your hands to make Elegant even better! - -Check <https://github.com/Pelican-Elegant/elegant/blob/master/CONTRIBUTING.md> for more details on how to help us improve! From ae41e72425bad9d303e9722d8cfccd2d4cfc03d9 Mon Sep 17 00:00:00 2001 From: Talha Mansoor <talha131@gmail.com> Date: Wed, 3 Jul 2019 22:17:45 +0500 Subject: [PATCH 49/52] docs(add): add docs on contributing code --- .../content/Contributing/adding-new-features | 12 ++++++ .../content/Contributing/beginners-guide.md | 38 ------------------- .../content/Contributing/jinja-style.md | 15 ++++++++ 3 files changed, 27 insertions(+), 38 deletions(-) create mode 100644 documentation/content/Contributing/adding-new-features create mode 100644 documentation/content/Contributing/jinja-style.md diff --git a/documentation/content/Contributing/adding-new-features b/documentation/content/Contributing/adding-new-features new file mode 100644 index 00000000..c139d0c0 --- /dev/null +++ b/documentation/content/Contributing/adding-new-features @@ -0,0 +1,12 @@ +--- +Title: Contributing New Features +Date: 2019-07-03 22:17 +Slug: contributing-new-features +Category: Contributing +--- + +If you plan to add new features to the theme, please make sure that: + +- you set sensible defaults so the theme works out of the box, without forcing the user to set any variable +- your changes do not negatively effect readability and reading experience +- your changes do not cause distraction for the reader diff --git a/documentation/content/Contributing/beginners-guide.md b/documentation/content/Contributing/beginners-guide.md index 4213b7d9..0a2b9999 100644 --- a/documentation/content/Contributing/beginners-guide.md +++ b/documentation/content/Contributing/beginners-guide.md @@ -31,42 +31,4 @@ In both cases, the following command is your Swiss-army knife: For more on the interactive rebase command of Git, see [its official documentation][git_rebase]. [git_rebase]: https://git-scm.com/docs/user-manual#interactive-rebase - -# New Features and Styles - -If you plan to add new features to the theme, please make sure that: - -- you set sensible defaults so the theme works out of the box, without forcing the user to set any variable -- your changes do not negatively effect readability and reading experience -- your changes do not cause distraction for the reader -- any bigger features should go through the voting process (see below) - -# Code style - -Please make sure to follow the code style of the existing code base. - -Specifically: - -## Code/Template Formatting Rules - -- use single (`''`) rather than double (`""`) quotation marks for Jinja strings -- in Jinja print statements, surround the variable with spaces inside curly braces – for example: `{{ foo.bar }}` -- use double (`""`) quotation marks around HTML attributes -- end files with a newline - -## CSS Formatting Rules - -- font name’s first letter should be capital -- add a space after comma -- declarations should be sorted alphabetically -- use a single space between the last selector and the opening brace that begins the declaration block -- group together related classes and identities -- add a space after colon -- remove leading 0s -- remove unit specification after 0 values -- use three-digit Hex notation for colors wherever possible -- use hyphen `-` instead of underscore `_` in class and identity names - -Refer to [Google's HTML/CSS Style Guide][google_style_guide] for all other formatting rules. - [elegant]: https://github.com/Pelican-Elegant/elegant diff --git a/documentation/content/Contributing/jinja-style.md b/documentation/content/Contributing/jinja-style.md new file mode 100644 index 00000000..fe6b112b --- /dev/null +++ b/documentation/content/Contributing/jinja-style.md @@ -0,0 +1,15 @@ +--- +Title: Code Style for Jinja2 +Date: 2019-07-03 22:17 +Slug: code-style-for-jinja2 +Category: Contributing +--- + +Please make sure to follow the code style of the existing code base. + +Specifically: + +- use single (`''`) rather than double (`""`) quotation marks for Jinja strings +- in Jinja print statements, surround the variable with spaces inside curly braces – for example: `{{ foo.bar }}` +- use double (`""`) quotation marks around HTML attributes +- end files with a newline From 596f2c26ea906507c3a82970d4690da699833439 Mon Sep 17 00:00:00 2001 From: Talha Mansoor <talha131@gmail.com> Date: Wed, 3 Jul 2019 22:19:44 +0500 Subject: [PATCH 50/52] docs(update): fix url of internal file --- documentation/content/Release Notes/release-notes-2.0.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/content/Release Notes/release-notes-2.0.0.md b/documentation/content/Release Notes/release-notes-2.0.0.md index 4baeea35..509caa83 100644 --- a/documentation/content/Release Notes/release-notes-2.0.0.md +++ b/documentation/content/Release Notes/release-notes-2.0.0.md @@ -17,7 +17,7 @@ With more than 4 years in the making, this release started "better late then nev With the [community spark re-ignited][announcement_community], this has become the biggest release since probably 1.0. And as such a very worthy release to carry the 2.0 crown. -[announcement_community]: {filename}../Announcements/community-driven-project.md +[announcement_community]: {filename}../Contributing/community-driven-project.md # Elegant v 2.0 is finally here! From 59826df1083ab0422776ee2dad7131384781a300 Mon Sep 17 00:00:00 2001 From: Talha Mansoor <talha131@gmail.com> Date: Wed, 3 Jul 2019 23:16:06 +0500 Subject: [PATCH 51/52] docs(update): add authors to articles Close #360 --- documentation/content/Analytics/google-analytics.md | 6 ++++-- documentation/content/Analytics/stat-counter.md | 6 ++++-- .../content/Appearance and Style/article-subtitle.md | 1 + .../content/Appearance and Style/modified-date.md | 3 +++ .../content/Appearance and Style/page-title.md | 1 + .../content/Appearance and Style/table-of-contents.md | 3 +++ .../content/Appearance and Style/web-safe-fonts.md | 3 +++ documentation/content/Code Snippets/code-style.md | 1 + .../content/Code Snippets/custome-syntax-theme.md | 1 + .../Code Snippets/line-numbers-code-snippet.md | 3 +++ .../content/Comments/collapsible-comments.md | 1 + documentation/content/Comments/comment-id.md | 1 + documentation/content/Comments/disable-comments.md | 1 + documentation/content/Comments/disqus-comments.md | 3 +++ documentation/content/Comments/invite-comments.md | 1 + .../{adding-new-features => adding-new-features.md} | 1 + documentation/content/Contributing/jinja-style.md | 1 + .../favicons-speed-dial-icons.md | 3 +++ .../content/Elegant - Pelican Theme/testimonials.md | 3 +++ .../content/Extra Customization/change-labels.md | 1 + .../content/Extra Customization/custom-404.md | 1 + .../content/Extra Customization/custom-style.md | 1 + .../content/Extra Customization/customize-elegant.md | 3 +++ .../content/Extra Customization/meta-data.md | 1 + documentation/content/Footer/add-license.md | 3 +++ documentation/content/Footer/hosted-on.md | 1 + documentation/content/Footer/site-subtitle.md | 3 +++ documentation/content/Landing Page/about-me.md | 1 + documentation/content/Landing Page/landing-page.md | 1 + documentation/content/Landing Page/projects-list.md | 1 + documentation/content/Landing Page/recent-articles.md | 1 + documentation/content/Landing Page/welcome.md | 1 + documentation/content/Mailing List/freelists.md | 1 + documentation/content/Mailing List/mailchimp.md | 1 + documentation/content/Monetization/amazon-one-link.md | 2 +- documentation/content/SEO and SMO/rss-feeds.md | 3 +++ .../content/SEO and SMO/seo-social-media-tags.md | 3 +++ .../content/SEO and SMO/social-profiles-sidebar.md | 3 +++ documentation/content/Search/tipue-search.md | 1 + documentation/content/Taxonomy/article-count.md | 1 + documentation/content/Taxonomy/filter-tags.md | 1 + .../content/Taxonomy/zero-clutter-category.md | 1 + documentation/pelicanconf.py | 11 +++++++++++ 43 files changed, 85 insertions(+), 5 deletions(-) rename documentation/content/Contributing/{adding-new-features => adding-new-features.md} (94%) diff --git a/documentation/content/Analytics/google-analytics.md b/documentation/content/Analytics/google-analytics.md index 3e339372..442828af 100644 --- a/documentation/content/Analytics/google-analytics.md +++ b/documentation/content/Analytics/google-analytics.md @@ -1,3 +1,4 @@ +--- Title: How to use Google Analytics Tags: web-analytics Category: Analytics @@ -5,9 +6,10 @@ Date: 2013-11-11 23:05 Slug: how-to-use-google-analytics Disqus_identifier: cf14ac5-how-to-use-google-analytics Subtitle: -Summary: Elegant Pelican theme supports Google Analytics out of -the box. This articles describes how to set it up. +Summary: Elegant Pelican theme supports Google Analytics out of the box. This articles describes how to set it up. Keywords: +authors: Talha Mansoor +--- Elegant supports the popular web tracking service, [Google Analytics](http://www.google.com/analytics/). diff --git a/documentation/content/Analytics/stat-counter.md b/documentation/content/Analytics/stat-counter.md index bce0ff48..6475ec70 100644 --- a/documentation/content/Analytics/stat-counter.md +++ b/documentation/content/Analytics/stat-counter.md @@ -1,3 +1,4 @@ +--- Title: How to use StatCounter Tags: web-analytics Category: Analytics @@ -5,9 +6,10 @@ Date: 2013-11-11 23:05 Slug: how-to-use-statcounter-analytics Disqus_identifier: 4kv80xq-how-to-use-statcounter Subtitle: -Summary: Elegant Pelican theme supports StatCounter out of -the box. This articles describes how to set them up. +Summary: Elegant Pelican theme supports StatCounter out of the box. This articles describes how to set them up. Keywords: +authors: Talha Mansoor +--- Elegant has support for popular web tracking service, [StatCounter](http://statcounter.com/). diff --git a/documentation/content/Appearance and Style/article-subtitle.md b/documentation/content/Appearance and Style/article-subtitle.md index 71d309aa..30868df2 100644 --- a/documentation/content/Appearance and Style/article-subtitle.md +++ b/documentation/content/Appearance and Style/article-subtitle.md @@ -6,6 +6,7 @@ Date: 2013-08-27 23:20 comments: false Slug: article-subtitle Category: Appearance & Style +authors: Talha Mansoor --- Pelican lets you define title of your article in the meta data. Elegant adds diff --git a/documentation/content/Appearance and Style/modified-date.md b/documentation/content/Appearance and Style/modified-date.md index 96be6ec1..fa5b3fba 100644 --- a/documentation/content/Appearance and Style/modified-date.md +++ b/documentation/content/Appearance and Style/modified-date.md @@ -1,3 +1,4 @@ +--- Title: How does modified metadata works Tags: web-design, meta-data, date Category: Appearance & Style @@ -7,6 +8,8 @@ Disqus_identifier: q4nz2k0-how-does-modified-metadata-works Subtitle: Summary: Use modified metadata to show the date at which you last updated the article Keywords: +authors: Talha Mansoor +--- You need to update your articles time and again. Sometimes it makes sense to display the date when you updated the article. You can show the last updated diff --git a/documentation/content/Appearance and Style/page-title.md b/documentation/content/Appearance and Style/page-title.md index ce8e9eef..ef6b2bf2 100644 --- a/documentation/content/Appearance and Style/page-title.md +++ b/documentation/content/Appearance and Style/page-title.md @@ -6,6 +6,7 @@ Date: 2013-08-27 23:20 comments: false Slug: page-title Category: Appearance & Style +authors: Talha Mansoor --- Elegant follows following format for the `<title>` tag diff --git a/documentation/content/Appearance and Style/table-of-contents.md b/documentation/content/Appearance and Style/table-of-contents.md index dd7a5a1d..2a677d93 100644 --- a/documentation/content/Appearance and Style/table-of-contents.md +++ b/documentation/content/Appearance and Style/table-of-contents.md @@ -1,3 +1,4 @@ +--- Title: How Elegant displays Table of Contents Tags: reST, markdown, navigation, web-design, contents Category: Appearance & Style @@ -7,6 +8,8 @@ Disqus_identifier: lm95rjd-how-elegant-displays-table-of-contents Subtitle: Summary: Elegant shows Table of Contents, if available, non intrusively to give a clean reading experience to the visitor Keywords: +authors: Talha Mansoor +--- [TOC] diff --git a/documentation/content/Appearance and Style/web-safe-fonts.md b/documentation/content/Appearance and Style/web-safe-fonts.md index c74db7d1..2a082287 100644 --- a/documentation/content/Appearance and Style/web-safe-fonts.md +++ b/documentation/content/Appearance and Style/web-safe-fonts.md @@ -1,8 +1,11 @@ +--- Title: Web Safe Fonts Tags: web-design Category: Appearance & Style Date: 2014-04-22 16:23 Slug: web-safe-fonts +authors: Talha Mansoor +--- Elegant uses commonly available typefaces in every style rule. It has a list of closely matching fonts in the fallback list. diff --git a/documentation/content/Code Snippets/code-style.md b/documentation/content/Code Snippets/code-style.md index e98b8bf7..c87ea2d4 100644 --- a/documentation/content/Code Snippets/code-style.md +++ b/documentation/content/Code Snippets/code-style.md @@ -6,6 +6,7 @@ Date: 2013-08-27 23:20 comments: false Slug: code-snippets-theme Category: Code Snippets +authors: Talha Mansoor --- Elegant uses [Solarized](http://ethanschoonover.com/solarized) theme for syntax diff --git a/documentation/content/Code Snippets/custome-syntax-theme.md b/documentation/content/Code Snippets/custome-syntax-theme.md index 8b8d9358..0887e94c 100644 --- a/documentation/content/Code Snippets/custome-syntax-theme.md +++ b/documentation/content/Code Snippets/custome-syntax-theme.md @@ -4,6 +4,7 @@ Tags: unique Date: 2019-07-03 20:18 Slug: change-syntax-highlight-theme Category: Code Snippets +authors: Talha Mansoor --- Elegant uses [Solarized theme](http://ethanschoonover.com/solarized) for syntax diff --git a/documentation/content/Code Snippets/line-numbers-code-snippet.md b/documentation/content/Code Snippets/line-numbers-code-snippet.md index a4485898..94fdb9a2 100644 --- a/documentation/content/Code Snippets/line-numbers-code-snippet.md +++ b/documentation/content/Code Snippets/line-numbers-code-snippet.md @@ -1,3 +1,4 @@ +--- Title: Display Line Numbers in Code Snippets Tags: markdown, reST, code-snippets, gist Category: Code Snippets @@ -6,6 +7,8 @@ Slug: display-line-numbers-in-code-snippets Subtitle: Summary: reStructuredText and Markdown have directives that generate line numbers for code blocks. Use them to display line numbers in code snippets. Keywords: codehilite, python-markdown +authors: Talha Mansoor +--- reStructuredText and Markdown have directives that generate line numbers for code snippets. Install [Pygments](http://pygments.org/) to use these directives. diff --git a/documentation/content/Comments/collapsible-comments.md b/documentation/content/Comments/collapsible-comments.md index 66d46995..19f2609b 100644 --- a/documentation/content/Comments/collapsible-comments.md +++ b/documentation/content/Comments/collapsible-comments.md @@ -6,6 +6,7 @@ Date: 2013-08-27 23:20 comments: false Slug: collapsible-comments Category: Commenting +authors: Talha Mansoor --- Readers use scroll bar to track their progress when reading inside their diff --git a/documentation/content/Comments/comment-id.md b/documentation/content/Comments/comment-id.md index 2b85cd22..06e860fe 100644 --- a/documentation/content/Comments/comment-id.md +++ b/documentation/content/Comments/comment-id.md @@ -6,6 +6,7 @@ date: 2019-06-30 22:29 comments: false Slug: comments-thread-id Category: Commenting +authors: Talha Mansoor --- Most Pelican themes pass article URL to Disqus as the [Disqus diff --git a/documentation/content/Comments/disable-comments.md b/documentation/content/Comments/disable-comments.md index c2150287..3aef9ede 100644 --- a/documentation/content/Comments/disable-comments.md +++ b/documentation/content/Comments/disable-comments.md @@ -6,6 +6,7 @@ date: 2019-01-12 16:29 comments: false Slug: disable-comments-per-article Category: Commenting +authors: Talha Mansoor --- If you remove your comment service configuration, say you set `DISQUS_SITENAME` to empty string, then comments will disappear from all the articles. diff --git a/documentation/content/Comments/disqus-comments.md b/documentation/content/Comments/disqus-comments.md index ef4f1e0d..53dd934b 100644 --- a/documentation/content/Comments/disqus-comments.md +++ b/documentation/content/Comments/disqus-comments.md @@ -1,3 +1,4 @@ +--- Title: Enable Disqus Comments Tags: interaction Category: Commenting @@ -6,6 +7,8 @@ Slug: enable-disqus-comments comment_id: 9jgwmy8-how-to-use-disqus-comments-elegantly Subtitle: Summary: Elegant offers Disqus comments out of the box with few unique features +authors: Talha Mansoor +--- You can use Disqus for comments. You have to set `DISQUS_SITENAME` to Disqus site name identifier in configuration to enable comments. diff --git a/documentation/content/Comments/invite-comments.md b/documentation/content/Comments/invite-comments.md index 399346bc..787e72e1 100644 --- a/documentation/content/Comments/invite-comments.md +++ b/documentation/content/Comments/invite-comments.md @@ -6,6 +6,7 @@ Date: 2014-04-21 16:39 comments: false Slug: invite-visitors-comment Category: Commenting +authors: Talha Mansoor --- Instead of just throwing in comments form at the end of every article, Elegant diff --git a/documentation/content/Contributing/adding-new-features b/documentation/content/Contributing/adding-new-features.md similarity index 94% rename from documentation/content/Contributing/adding-new-features rename to documentation/content/Contributing/adding-new-features.md index c139d0c0..9ba88fe5 100644 --- a/documentation/content/Contributing/adding-new-features +++ b/documentation/content/Contributing/adding-new-features.md @@ -3,6 +3,7 @@ Title: Contributing New Features Date: 2019-07-03 22:17 Slug: contributing-new-features Category: Contributing +authors: Talha Mansoor --- If you plan to add new features to the theme, please make sure that: diff --git a/documentation/content/Contributing/jinja-style.md b/documentation/content/Contributing/jinja-style.md index fe6b112b..e9923a71 100644 --- a/documentation/content/Contributing/jinja-style.md +++ b/documentation/content/Contributing/jinja-style.md @@ -3,6 +3,7 @@ Title: Code Style for Jinja2 Date: 2019-07-03 22:17 Slug: code-style-for-jinja2 Category: Contributing +authors: Talha Mansoor --- Please make sure to follow the code style of the existing code base. diff --git a/documentation/content/Elegant - Pelican Theme/favicons-speed-dial-icons.md b/documentation/content/Elegant - Pelican Theme/favicons-speed-dial-icons.md index ee6aded3..26080f38 100644 --- a/documentation/content/Elegant - Pelican Theme/favicons-speed-dial-icons.md +++ b/documentation/content/Elegant - Pelican Theme/favicons-speed-dial-icons.md @@ -1,3 +1,4 @@ +--- Title: How to set Shortcut Icons Tags: pelican-theme, web-design Category: Elegant - Pelican Theme @@ -7,6 +8,8 @@ Disqus_identifier: x0giyfl-how-to-set-shortcut-icons Subtitle: Summary: Elegant lets you set Favicon, Opera Speed Dial icon, and shortcut icons for Apple iOS and Android devices. Keywords: +authors: Talha Mansoor +--- Elegant supports Favicon, Opera Speed Dial, and shortcut or launcher icons on Apple iOS and Android devices. These are disabled by default to avoid diff --git a/documentation/content/Elegant - Pelican Theme/testimonials.md b/documentation/content/Elegant - Pelican Theme/testimonials.md index 703f6920..dd847b29 100644 --- a/documentation/content/Elegant - Pelican Theme/testimonials.md +++ b/documentation/content/Elegant - Pelican Theme/testimonials.md @@ -1,3 +1,4 @@ +--- Title: What People Say About Elegant Tags: pelican-theme, testimonials Category: Elegant - Pelican Theme @@ -7,6 +8,8 @@ Disqus_identifier: qryv67o-what-people-say-about-elegant Subtitle: Summary: Keywords: +authors: Talha Mansoor +--- > Thanks for this amazing project. diff --git a/documentation/content/Extra Customization/change-labels.md b/documentation/content/Extra Customization/change-labels.md index 35c5241b..27b7242a 100644 --- a/documentation/content/Extra Customization/change-labels.md +++ b/documentation/content/Extra Customization/change-labels.md @@ -1,4 +1,5 @@ --- +authors: Talha Mansoor Title: Change Labels Tags: unique Date: 2019-07-03 20:20 diff --git a/documentation/content/Extra Customization/custom-404.md b/documentation/content/Extra Customization/custom-404.md index 69cfc3ad..f48ed6d3 100644 --- a/documentation/content/Extra Customization/custom-404.md +++ b/documentation/content/Extra Customization/custom-404.md @@ -1,4 +1,5 @@ --- +authors: Talha Mansoor Title: Custom 404 Page Tags: unique Date: 2019-07-03 20:07 diff --git a/documentation/content/Extra Customization/custom-style.md b/documentation/content/Extra Customization/custom-style.md index 1be07a21..b8297745 100644 --- a/documentation/content/Extra Customization/custom-style.md +++ b/documentation/content/Extra Customization/custom-style.md @@ -1,4 +1,5 @@ --- +authors: Talha Mansoor Title: Customize Style Tags: unique Date: 2019-07-03 20:14 diff --git a/documentation/content/Extra Customization/customize-elegant.md b/documentation/content/Extra Customization/customize-elegant.md index a90ac00e..b03e9b07 100644 --- a/documentation/content/Extra Customization/customize-elegant.md +++ b/documentation/content/Extra Customization/customize-elegant.md @@ -1,3 +1,4 @@ +--- Title: How to Customize Elegant Tags: config Category: Extra Customization @@ -7,6 +8,8 @@ Disqus_identifier: ale31i7-how-to-customize-elegant Subtitle: Summary: You can customize every aspect of Elegant without touching the source code Keywords: +authors: Talha Mansoor +--- [TOC] diff --git a/documentation/content/Extra Customization/meta-data.md b/documentation/content/Extra Customization/meta-data.md index e9d08240..a12043d7 100644 --- a/documentation/content/Extra Customization/meta-data.md +++ b/documentation/content/Extra Customization/meta-data.md @@ -1,4 +1,5 @@ --- +authors: Talha Mansoor Title: Metadata Tags: unique Date: 2019-07-03 20:44 diff --git a/documentation/content/Footer/add-license.md b/documentation/content/Footer/add-license.md index aa7f6e41..ff8c12c9 100644 --- a/documentation/content/Footer/add-license.md +++ b/documentation/content/Footer/add-license.md @@ -1,9 +1,12 @@ +--- Title: Add License to your Site Tags: nuances Category: Footer Date: 2014-04-22 16:23 Slug: add-license-to-your-site Summary: You can display your preferred license in the footer +authors: Talha Mansoor +--- You can optionally define `SITE_LICENSE` variable in Pelican configuration. It will appear in the footer of the site. diff --git a/documentation/content/Footer/hosted-on.md b/documentation/content/Footer/hosted-on.md index 513ccf33..619c753f 100644 --- a/documentation/content/Footer/hosted-on.md +++ b/documentation/content/Footer/hosted-on.md @@ -1,5 +1,6 @@ --- Title: Show Your Host Information +authors: Talha Mansoor Tags: nuances layout: post date: 2019-06-30 11:54 diff --git a/documentation/content/Footer/site-subtitle.md b/documentation/content/Footer/site-subtitle.md index 82cf329c..fb757f8e 100644 --- a/documentation/content/Footer/site-subtitle.md +++ b/documentation/content/Footer/site-subtitle.md @@ -1,9 +1,12 @@ +--- Title: Add Site Subtitle Tags: nuances Category: Footer Date: 2014-04-22 16:23 Slug: add-site-subtitle Summary: You can add and display a site subtitle +authors: Talha Mansoor +--- You can optionally define `SITE_SUBTITLE` variable in Pelican configuration. It will appear in the footer of the site. diff --git a/documentation/content/Landing Page/about-me.md b/documentation/content/Landing Page/about-me.md index 834d9875..09175a04 100644 --- a/documentation/content/Landing Page/about-me.md +++ b/documentation/content/Landing Page/about-me.md @@ -1,4 +1,5 @@ --- +authors: Talha Mansoor Title: Write About Me Tags: remarkable, unique, home layout: post diff --git a/documentation/content/Landing Page/landing-page.md b/documentation/content/Landing Page/landing-page.md index 9980ef5c..2a1293b2 100644 --- a/documentation/content/Landing Page/landing-page.md +++ b/documentation/content/Landing Page/landing-page.md @@ -1,4 +1,5 @@ --- +authors: Talha Mansoor Title: Unique Home Page Features Tags: home, remarkable, unique, guide layout: post diff --git a/documentation/content/Landing Page/projects-list.md b/documentation/content/Landing Page/projects-list.md index 8a70606c..3097296d 100644 --- a/documentation/content/Landing Page/projects-list.md +++ b/documentation/content/Landing Page/projects-list.md @@ -1,4 +1,5 @@ --- +authors: Talha Mansoor Title: Projects List Tags: remarkable, unique, home layout: post diff --git a/documentation/content/Landing Page/recent-articles.md b/documentation/content/Landing Page/recent-articles.md index 57d7810c..5ed1bd38 100644 --- a/documentation/content/Landing Page/recent-articles.md +++ b/documentation/content/Landing Page/recent-articles.md @@ -1,4 +1,5 @@ --- +authors: Talha Mansoor Title: Recent Articles List Tags: remarkable, unique, home layout: post diff --git a/documentation/content/Landing Page/welcome.md b/documentation/content/Landing Page/welcome.md index 7b44e3ba..8222f4f2 100644 --- a/documentation/content/Landing Page/welcome.md +++ b/documentation/content/Landing Page/welcome.md @@ -1,4 +1,5 @@ --- +authors: Talha Mansoor Title: Write Welcome Message Tags: remarkable, unique, home layout: post diff --git a/documentation/content/Mailing List/freelists.md b/documentation/content/Mailing List/freelists.md index cc0915a5..c94e11a0 100644 --- a/documentation/content/Mailing List/freelists.md +++ b/documentation/content/Mailing List/freelists.md @@ -6,6 +6,7 @@ Date: 2018-07-05 23:20 comments: false Slug: add-freelists Category: Mailing List +authors: Talha Mansoor --- Elegant shows a form to subscribe to your newsletter, above the fold, in the right section of every article. diff --git a/documentation/content/Mailing List/mailchimp.md b/documentation/content/Mailing List/mailchimp.md index fce1a24a..a8798f08 100644 --- a/documentation/content/Mailing List/mailchimp.md +++ b/documentation/content/Mailing List/mailchimp.md @@ -6,6 +6,7 @@ Date: 2013-08-27 23:20 comments: false Slug: add-mailchimp Category: Mailing List +authors: Talha Mansoor --- Elegant shows a form to subscribe to your newsletter, above the fold, in the right section of every article. Increased visibility is said to increase number of subscribers. diff --git a/documentation/content/Monetization/amazon-one-link.md b/documentation/content/Monetization/amazon-one-link.md index 96640f8e..42394eec 100644 --- a/documentation/content/Monetization/amazon-one-link.md +++ b/documentation/content/Monetization/amazon-one-link.md @@ -1,5 +1,5 @@ --- -author: Pablo Iranzo Gómez (pablo.iranzo@gmail.com) +authors: Pablo Iranzo Gómez, Talha Mansoor title: Amazon OneLink Support tags: amazon, affiliates, income layout: post diff --git a/documentation/content/SEO and SMO/rss-feeds.md b/documentation/content/SEO and SMO/rss-feeds.md index 022022dd..6e9515e8 100644 --- a/documentation/content/SEO and SMO/rss-feeds.md +++ b/documentation/content/SEO and SMO/rss-feeds.md @@ -1,3 +1,4 @@ +--- Title: How to show RSS feeds icon Tags: pelican-theme, font-awesome, web-design Category: SEO & SMO @@ -7,6 +8,8 @@ Disqus_identifier: ijvxwtg-how-to-show-rss-feeds-icon Subtitle: Summary: Elegant supports RSS and Atom feeds for your posts, categories and tags Keywords: +authors: Talha Mansoor +--- RSS feeds is the oldest and arguably the most used format to publish blog updates. Its use is not limited to RSS aggregators and readers. Tools like diff --git a/documentation/content/SEO and SMO/seo-social-media-tags.md b/documentation/content/SEO and SMO/seo-social-media-tags.md index 92896c45..2d94f57f 100644 --- a/documentation/content/SEO and SMO/seo-social-media-tags.md +++ b/documentation/content/SEO and SMO/seo-social-media-tags.md @@ -1,3 +1,4 @@ +--- Title: Search Engine and Social Media Optimization Tags: crawler, social-media, web-analytics Category: SEO & SMO @@ -6,6 +7,8 @@ Slug: search-engine-and-social-media-optimization Disqus_identifier: 7mh4xjn-search-engine-and-social-media-optimization Summary: Keywords: +authors: Talha Mansoor +--- [TOC] diff --git a/documentation/content/SEO and SMO/social-profiles-sidebar.md b/documentation/content/SEO and SMO/social-profiles-sidebar.md index 04fc8703..65966588 100644 --- a/documentation/content/SEO and SMO/social-profiles-sidebar.md +++ b/documentation/content/SEO and SMO/social-profiles-sidebar.md @@ -1,3 +1,4 @@ +--- Title: How to display your Social Media Profiles Tags: pelican-theme, font-awesome, social-media, web-design Category: SEO & SMO @@ -7,6 +8,8 @@ Disqus_identifier: k7fpj4y-how-to-display-your-social-media-profiles Subtitle: Summary: Elegant displays links to your social media profiles in sidebar in a customizable manner Keywords: +authors: Talha Mansoor +--- Bloggers use different tools to connect with their readers, engage in discussion with them, and create a loyal following of fans. These tools range diff --git a/documentation/content/Search/tipue-search.md b/documentation/content/Search/tipue-search.md index 1b68bfc0..3daa6a86 100644 --- a/documentation/content/Search/tipue-search.md +++ b/documentation/content/Search/tipue-search.md @@ -1,4 +1,5 @@ --- +authors: Talha Mansoor Title: Add Search to your Site Tags: unique Date: 2019-07-03 19:56 diff --git a/documentation/content/Taxonomy/article-count.md b/documentation/content/Taxonomy/article-count.md index d1d89664..286b724e 100644 --- a/documentation/content/Taxonomy/article-count.md +++ b/documentation/content/Taxonomy/article-count.md @@ -1,5 +1,6 @@ --- Title: Articles Count With Every Tag & Category +authors: Talha Mansoor Tags: nuances layout: post Date: 2013-08-27 23:20 diff --git a/documentation/content/Taxonomy/filter-tags.md b/documentation/content/Taxonomy/filter-tags.md index c1abcf67..8de7696f 100644 --- a/documentation/content/Taxonomy/filter-tags.md +++ b/documentation/content/Taxonomy/filter-tags.md @@ -1,4 +1,5 @@ --- +authors: Talha Mansoor Title: Live Filter for Tags Tags: nuances, search layout: post diff --git a/documentation/content/Taxonomy/zero-clutter-category.md b/documentation/content/Taxonomy/zero-clutter-category.md index 0f538a1e..8e752e66 100644 --- a/documentation/content/Taxonomy/zero-clutter-category.md +++ b/documentation/content/Taxonomy/zero-clutter-category.md @@ -6,6 +6,7 @@ Date: 2013-08-27 23:20 comments: false Slug: zero-clutter-categories Category: Taxonomy +authors: Talha Mansoor --- Pelican by default creates a separate page for each category. Themes list all diff --git a/documentation/pelicanconf.py b/documentation/pelicanconf.py index 9a0e4d73..87a63e29 100644 --- a/documentation/pelicanconf.py +++ b/documentation/pelicanconf.py @@ -151,3 +151,14 @@ ] LANDING_PAGE_TITLE = "Elegant – Why it is the Best Pelican Theme" + +AUTHORS = { + "Talha Mansoor": { + "url": "https://www.oncrashreboot.com/", + "blurb": "is the creator and lead developer of Elegant theme.", + }, + "Pablo Iranzo Gómez": { + "url": "http://iranzo.github.io", + "blurb": "has been involved with open source projects for more than a decade.", + }, +} From b184299de43d37770b1bae031a25695e4cdc1014 Mon Sep 17 00:00:00 2001 From: Talha Mansoor <talha131@gmail.com> Date: Wed, 3 Jul 2019 23:23:19 +0500 Subject: [PATCH 52/52] docs(update): fix spelling --- documentation/content/Contributing/contributing-license.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/content/Contributing/contributing-license.md b/documentation/content/Contributing/contributing-license.md index 26971d18..a0caf9e9 100644 --- a/documentation/content/Contributing/contributing-license.md +++ b/documentation/content/Contributing/contributing-license.md @@ -1,5 +1,5 @@ --- -Title: Contributions Licesne +Title: Contributions License Date: 2019-07-03 22:07 Slug: contribution-license Category: Contributing