From 63d4412ba65217ca21092565bf3e6bcc2706e575 Mon Sep 17 00:00:00 2001 From: Henk Verlinde Date: Sat, 9 Jul 2022 09:46:39 +0200 Subject: [PATCH] content: update content for Doks v0.5.0 --- config/_default/config.toml | 3 +- content/en/blog/say-hello-to-doks/index.md | 10 +++++-- .../say-hello-to-doks/say-hello-to-doks.png | Bin 8211 -> 0 bytes content/en/docs/help/_index.md | 1 + content/en/docs/lorem/_index.md | 10 +++++++ content/en/docs/lorem/ipsum/_index.md | 15 ++++++++++ content/en/docs/lorem/ipsum/amet/_index.md | 15 ++++++++++ .../lorem/ipsum/amet/consectetur/index.md | 14 +++++++++ content/en/docs/lorem/ipsum/dolor/index.md | 14 +++++++++ content/en/docs/lorem/ipsum/sit/index.md | 14 +++++++++ content/en/docs/prologue/_index.md | 1 + content/en/docs/prologue/commands.md | 14 +++++++++ content/en/docs/prologue/quick-start.md | 28 ++++++++++++------ content/en/privacy-policy/index.md | 2 +- 14 files changed, 128 insertions(+), 13 deletions(-) delete mode 100644 content/en/blog/say-hello-to-doks/say-hello-to-doks.png create mode 100644 content/en/docs/lorem/_index.md create mode 100644 content/en/docs/lorem/ipsum/_index.md create mode 100644 content/en/docs/lorem/ipsum/amet/_index.md create mode 100644 content/en/docs/lorem/ipsum/amet/consectetur/index.md create mode 100644 content/en/docs/lorem/ipsum/dolor/index.md create mode 100644 content/en/docs/lorem/ipsum/sit/index.md diff --git a/config/_default/config.toml b/config/_default/config.toml index 84c789c..4ad3924 100644 --- a/config/_default/config.toml +++ b/config/_default/config.toml @@ -5,7 +5,6 @@ disableHugoGeneratorInject = true enableEmoji = true enableGitInfo = false enableRobotsTXT = true -languageCode = "en-US" paginate = 7 rssLimit = 10 @@ -59,6 +58,8 @@ rel = "sitemap" [taxonomies] contributor = "contributors" + category = "categories" + tag = "tags" [permalinks] blog = "/blog/:title/" diff --git a/content/en/blog/say-hello-to-doks/index.md b/content/en/blog/say-hello-to-doks/index.md index e9c3185..d14d357 100644 --- a/content/en/blog/say-hello-to-doks/index.md +++ b/content/en/blog/say-hello-to-doks/index.md @@ -1,11 +1,17 @@ --- title: "Say hello to Doks 👋" description: "Introducing Doks, a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default." -lead: "Introducing Doks, a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default." +excerpt: "Introducing Doks, a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default." date: 2020-11-04T09:19:42+01:00 lastmod: 2020-11-04T09:19:42+01:00 draft: false weight: 50 -images: ["say-hello-to-doks.png"] +images: [] +categories: ["News"] +tags: ["security", "performance", "SEO"] contributors: ["Henk Verlinde"] +pinned: false +homepage: false --- + +Introducing Doks, a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default. diff --git a/content/en/blog/say-hello-to-doks/say-hello-to-doks.png b/content/en/blog/say-hello-to-doks/say-hello-to-doks.png deleted file mode 100644 index 70d8c78611ae4033c26e2d795b2f959133ec6cb4..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 8211 zcmeHMX;f3mwyq!u<}x{eb{GV&4ay*hq96@UpwgHiG7kc+jR-*oF)|5>b2Hmb3xW(H z^OP_cf{bZVkp@JCBoYV#5rKpxOd*&Ma!-8k{=M(d`*DAewX*i9vretrwQKM1`>HDO z9O|?Z903OaDA}K}Jr95!^eBT<*a(@8z~-*;sPvD=!{}-ub!zyD!6u(g zS!do~eO}z~V;C_pb6?BL3m(Vi{}?zPpYo@2S)=o?HP^naOQ5OOvkTkW-`jd%qJ!Xo z7}8z*mR423or*~ih>ot#Gqs>`f$9wQh}7z20tKo4OZJ%5DChwh$Q(0;sY;u-H{qm4 z^(>Hu49;IhN7|I#3Sf}YdA#0rJxuE%{TjPm;AJ5a&PseJ6IcjwW7P zCUs!Cy1F1a&?!yd$Jvh_J@OT_#4KKx2jrU`GKx~J|IfOhcP|-`eHd+VB#pnjMS`LN zo+AnxVoU-d0(oSl8B;YpG&J*dyz_wyqdQ39CKe%=o}SiRG%>-Qn+sp!0T7<2fCI;h zpBxTL3nhgyxl}4OK_r+MP>l``f6w9Z(r@bkPz?EpLzmq4XB;|o=+wY1f^Qq*9$Bz6 zOJxH%hJZM@sWI4oVR?CZTF}=XEvM7;BrF+(;teI0r&$N3=~AK z%#H7nRgUr64?u4QBx2^W=Yw9C!k|t%ko?IlDuwyAM(>B;hTL;Q{{aS!D#T(jcV)VKX1}4KVbQrL(YrkE*S;r=>Xd(uQK@c%HL(a9 z8xMyZ_3#q$Mlo?=%o`b%z@zLNzNRKM0cG`f{K2{GNJYd|BS1HZ;JUlv@KcjsI0Ml*XW9HkDU=6>Oadv~-YE=mtfZADz z%Er8^Ru0c}w-dKDDQ|}XT!6H&X`=@>&wVI54dsf_0jTd&k)v#N#vSiL*{6Gt0g#z3 z4Wg4B*`45vscFBq%M<_yX*sOeYAK#ClO;8g+PSv=(1%jBIhUPf;&+JA@tH}_^1G3I z4IMB^dZKFSSKu254ac{GvJYFaiQG(_<&c&s?u^l4662wP8HGL49^cXuIfWu!J3eP+ zY59Y3kj;@JLeAoIZdg+3TU?L1|GqSRP6rkVd@ji3L9>1tg%3uPugMl1_FWT9}3DNZE5X#c%}>z)x~E;j!MDU`v| zwz>JKrlzJZ#FJ-nma^!k*pj4M`;5N4d}H8}UMjY#jK(ra-gw?I=lk2)R{b;jaU|LHpPZ`NXieQvhH42D+7wFrfbR~@_#Ny4)g zcjpYps2ine*aC!~K;JPxB|#oM-Y#`ZQ$Do}#>_WUcMYkWbKe@fXwh4=%f&b{VRa>f zGz)nVrvE9cPGRMNJ>V7S8Xb!A~`ITO#c|2)*H_fF{1s9<5gI!vbr=Z|PUp?zdG_(t8l zXbQ-xxeykG-zq99DlKVKdniOHQS-4qjgrxor%5@_yo>E8{NnvGf-O}i=f<8|9kJ2Q z6Z({iGKE~WCCl`2rdWqPFA|Bg0QsDB^?zuNm^eiM9)%npRuXqOF?LNH#cS^LOPEnc zog5@|tO$|w6F0-WZ6uGbr7?vBKT#aKcKA*Bul7D#u@D@wSmd&P7K zfdI#xeDy5H7Hv6l34;R`X;|~kL$v6fuXOSDJ^bkT&#$kT)$>)i1DxGvX}sQ>aa?b) zcBy?7ZhW2OQzMUhzOs5QDf#A*s)iYX?)Q;-WkAF*R08cqOL2aDwT9Jk?k}=kCxP6&2NzmzVdU z``twyP@5vnyvXY6>Vu4qWm?Ny&izD^L@QhvHhZ-beYSzeI2a7C&lD?bNq*+^)6C>n zD(L!kr3k}~)c%;fd`0m7!S|{pz9}J`&XOg!5B#FmvM)KYA$)KSK|)-buFhThDKE;6 z^=dLmu%p_ZoTE^^!=qyZF#4ZrrtZb}EQ47MkZux_?-`VslI%tIisSS}=7eUJDbma} z9ObBmx&S2alJZ|6<|qk%Doc*|NDlcSuPnfmQ!M}?^Iy6%UTl0DA)8ClHR6vN{+gp8 z3)JnP1h6=XF3-NsYiejM7^tUZ?j>m)P{!5F*P%x80`FF%oqKKt*6ofC`DwF9&mApw znSXO`61JuXC6KovMkyrcvf>~{bN0~aYKW=YOO{vB?mZ|=WxC1r*=bcniE>m%2ap4U zUtCUxpKMUXEy5#>35)C$$MG8UGKa)Ggp{Ec8YR;m!l=5nx4$NDH_2631ikm9Y?BB- zThntuv`@l`d&X(i>-0h`i%lnhM{xhE9N7@3h(`YPubzkpWC)?MXE$5$#7Zz6+a8+M zO8Lw4>?OY#KFgIL;-_9wyZd#&+@~#wbOcH<)M+z^&!!>MD@w@8X_wXF(TH$*1zDKC zz3%xBpvhOd+|E(lk?cLMT*xd9Y+71cb34>MItoJ+#6NfpG@)5$o^(-<*z-1q)lzUH zCfs;Kq|0)&ogHwZjrdqc z4FNCeWY7>hJX2rOuNWVM>?fA@JME8DHxRli;@fn}E?o2}C{cz7eQS3|CCj%E`y~*hC{ftXH^V|D%q2+KqGAj8t73ynni27?la##9J$N0QA z^MuSh>5{m>z`#lc5A4n`gtA2h!t{TIi+X5H^{V<>aBxUYt@EwmkJj^}=BNQ=izYu( zLqnr)0Gp8?ZdE~dk09v&iE0Un(v;X>Z`!?{>MwA_h#!nvZ3a(OAi(?0#i=~=8uhvd z@)~DtWnyrg;G&AQT$zYeyX*DreN05~7NScd{&X@;X=_M>i~a`EY@s_X@DJx)la}^| z)-|YF79g!sTg=i)fk>i_=lA>N)-1ZJ{FOoNgqpa)yb?VH!=IPU)6S{A)?=g-maRfA zEciG_C+GNAO*UZ6!jWTq@jmvshwxlXo^V=2z>?5J<#WRbTX)3E@!bx8!+=l~Qg7k@gXZ>#I_}|7bS;lh=z4BM!V8pu>38L_#rzwINHibVRFiauX#2vv zmtr>BOj-DJ=gu9cv(*C3!u~UqSDw~^$WF?ll zLBTeHmEQ5cjtlrSzy1I?KC|iFXaCY3^D3!b+yDpXcCzekdA^EN?< ze@^QCX|?u*mGK9m4P75Ucvc3yF|TNRYb{`19}h^w2K=;tXh9nt6jm_V#?OV=KWe`t zzqx;nPf!N_XQXAxNzD@3M9=yE633*-ddM}|oxSb46rzMqK2IydBwj;{O!b|59=ofqMt82KW2D% zxXtlPO~*Z9%MPK{%9@Br7$M37d?{1Brh;9Kk_V>pYW_DMBC@L>yNhbH))soMbhFJI zTPeh5tYmH4KdF7Zk^sk=IR4X}bJPNTRJ`O&5V`t4S?06n{%p^PFDaF0V?+r&%#lTC z3m2I1@fwG?(vMw>T-pl!wIPu65B<6sING4DQkL8pC={w$P)52lFzwpmXD8ix3EScr z3<@Rmyjoi@wgp~r@@_|6%tkW&dVj&uFnBRW$xG!z#S}r+qb?$6hc`Ce{DK89ej^M> z;nVQhZTGy8mRQ6yR-iaau0o^iC|h8r{M7t{+xX&_ORLxao(&naz0Ba|`bvhQxIVFx zi2>gD*um?{TD}m^OPP!;YtW3Zu1-l9UETdM;Yd6j)GD@51Ax0stQH#N<|=|QXp;#2 z){ni{kNDTGGuCf?)^E7}j|0E|{xiuM{V$HXG=%^F diff --git a/content/en/docs/help/_index.md b/content/en/docs/help/_index.md index bc503ec..b5763a3 100644 --- a/content/en/docs/help/_index.md +++ b/content/en/docs/help/_index.md @@ -6,4 +6,5 @@ date: 2020-10-06T08:49:15+00:00 lastmod: 2020-10-06T08:49:15+00:00 draft: false images: [] +weight: 600 --- diff --git a/content/en/docs/lorem/_index.md b/content/en/docs/lorem/_index.md new file mode 100644 index 0000000..86fcd8f --- /dev/null +++ b/content/en/docs/lorem/_index.md @@ -0,0 +1,10 @@ +--- +title: "Lorem" +description: "" +lead: "" +date: 2022-01-18T19:58:14+01:00 +lastmod: 2022-01-18T19:58:14+01:00 +draft: true +images: [] +toc: true +--- diff --git a/content/en/docs/lorem/ipsum/_index.md b/content/en/docs/lorem/ipsum/_index.md new file mode 100644 index 0000000..e575fc5 --- /dev/null +++ b/content/en/docs/lorem/ipsum/_index.md @@ -0,0 +1,15 @@ +--- +title: "Ipsum" +description: "" +lead: "" +date: 2022-01-18T20:00:32+01:00 +lastmod: 2022-01-18T20:00:32+01:00 +draft: false +images: [] +menu: + docs: + parent: "lorem" + identifier: "ipsum" +weight: 999 +toc: true +--- diff --git a/content/en/docs/lorem/ipsum/amet/_index.md b/content/en/docs/lorem/ipsum/amet/_index.md new file mode 100644 index 0000000..dbbeabd --- /dev/null +++ b/content/en/docs/lorem/ipsum/amet/_index.md @@ -0,0 +1,15 @@ +--- +title: "Amet" +description: "" +lead: "" +date: 2022-01-18T20:07:56+01:00 +lastmod: 2022-01-18T20:07:56+01:00 +draft: false +images: [] +menu: + docs: + parent: "ipsum" + identifier: "amet" +weight: 999 +toc: true +--- diff --git a/content/en/docs/lorem/ipsum/amet/consectetur/index.md b/content/en/docs/lorem/ipsum/amet/consectetur/index.md new file mode 100644 index 0000000..23771e3 --- /dev/null +++ b/content/en/docs/lorem/ipsum/amet/consectetur/index.md @@ -0,0 +1,14 @@ +--- +title: "Consectetur" +description: "" +lead: "" +date: 2022-01-18T20:17:32+01:00 +lastmod: 2022-01-18T20:17:32+01:00 +draft: false +images: [] +menu: + docs: + parent: "amet" +weight: 730 +toc: true +--- diff --git a/content/en/docs/lorem/ipsum/dolor/index.md b/content/en/docs/lorem/ipsum/dolor/index.md new file mode 100644 index 0000000..a744e72 --- /dev/null +++ b/content/en/docs/lorem/ipsum/dolor/index.md @@ -0,0 +1,14 @@ +--- +title: "Dolor" +description: "" +lead: "" +date: 2022-01-18T20:01:45+01:00 +lastmod: 2022-01-18T20:01:45+01:00 +draft: false +images: [] +menu: + docs: + parent: "ipsum" +weight: 700 +toc: true +--- diff --git a/content/en/docs/lorem/ipsum/sit/index.md b/content/en/docs/lorem/ipsum/sit/index.md new file mode 100644 index 0000000..e4c84e4 --- /dev/null +++ b/content/en/docs/lorem/ipsum/sit/index.md @@ -0,0 +1,14 @@ +--- +title: "Sit" +description: "" +lead: "" +date: 2022-01-18T20:05:19+01:00 +lastmod: 2022-01-18T20:05:19+01:00 +draft: false +images: [] +menu: + docs: + parent: "ipsum" +weight: 710 +toc: true +--- diff --git a/content/en/docs/prologue/_index.md b/content/en/docs/prologue/_index.md index c3c1c40..d6b467c 100644 --- a/content/en/docs/prologue/_index.md +++ b/content/en/docs/prologue/_index.md @@ -6,4 +6,5 @@ date: 2020-10-06T08:48:45+00:00 lastmod: 2020-10-06T08:48:45+00:00 draft: false images: [] +weight: 100 --- diff --git a/content/en/docs/prologue/commands.md b/content/en/docs/prologue/commands.md index e647a98..a546026 100644 --- a/content/en/docs/prologue/commands.md +++ b/content/en/docs/prologue/commands.md @@ -25,6 +25,20 @@ npm run create [path] [flags] See also the Hugo docs: [hugo new](https://gohugo.io/commands/hugo_new/). +### Docs based tree + +Create a docs based tree — with a single command: + +```bash +npm run create -- --kind docs [section] +``` + +For example, create a docs based tree named guides: + +```bash +npm run create -- --kind docs guides +``` + ## lint Check scripts, styles, and markdown for errors: diff --git a/content/en/docs/prologue/quick-start.md b/content/en/docs/prologue/quick-start.md index 9282d3e..e42701e 100644 --- a/content/en/docs/prologue/quick-start.md +++ b/content/en/docs/prologue/quick-start.md @@ -15,9 +15,12 @@ toc: true ## Requirements -Doks uses npm to centralize dependency management, making it [easy to update]({{< relref "how-to-update" >}}) resources, build tooling, plugins, and build scripts: +- [Git](https://git-scm.com/) — latest source release +- [Node.js](https://nodejs.org/) — latest LTS version or newer -- Download and install [Node.js](https://nodejs.org/) (it includes npm) for your platform. +{{< details "Why Node.js?" >}} +Doks uses npm (included with Node.js) to centralize dependency management, making it [easy to update]({{< relref "how-to-update" >}}) resources, build tooling, plugins, and build scripts. +{{< /details >}} ## Start a new Doks project @@ -25,25 +28,32 @@ Create a new site, change directories, install dependencies, and start developme ### Create a new site -Doks is available as a child theme, and a starter theme: +Doks is available as a child theme and a starter theme. -- Use the Doks child theme, if you do __not__ plan to customize a lot, and/or need future Doks updates. -- Use the Doks starter theme, if you plan to customize a lot, and/or do __not__ need future Doks updates. +#### Child theme -Not quite sure? Use the Doks child theme. - -#### Doks child theme +- Intended for novice to intermediate users +- Intended for minor customizations +- [Easily update npm packages]({{< relref "how-to-update" >}}) — __including__ [Doks](https://www.npmjs.com/package/@hyas/doks) ```bash git clone https://github.com/h-enk/doks-child-theme.git my-doks-site ``` -#### Doks starter theme +#### Starter theme + +- Intended for intermediate to advanced users +- Intended for major customizations +- [Easily update npm packages]({{< relref "how-to-update" >}}) ```bash git clone https://github.com/h-enk/doks.git my-doks-site ``` +{{< details "Help me choose" >}} +Not sure which one is for you? Pick the child theme. +{{< /details >}} + ### Change directories ```bash diff --git a/content/en/privacy-policy/index.md b/content/en/privacy-policy/index.md index e95fd9f..6315024 100644 --- a/content/en/privacy-policy/index.md +++ b/content/en/privacy-policy/index.md @@ -31,6 +31,6 @@ We run [Plausible](https://plausible.io/) analytics on getdoks.org. The followin ## Contact us -[Contact us]({{< ref "contact/index.md" >}}) if you have any questions. +[Contact us]({{< relref "contact/index.md" >}}) if you have any questions. Effective Date: _27th August 2020_