From 658e4b6cda776758c18c32729af32f45842f2de3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andreas=20M=C3=BCller?= Date: Thu, 7 Aug 2025 16:24:37 +0200 Subject: [PATCH] Added base for automated documentation --- .gitignore | 3 ++ .gitlab-ci.yml | 26 ++++++++++++ docs/articles/getting-started.md | 1 + docs/articles/introduction.md | 1 + docs/articles/toc.yml | 8 ++++ docs/docfx.json | 63 ++++++++++++++++++++++++++++ docs/images/favicon.ico | Bin 0 -> 6491 bytes docs/images/logo.png | Bin 0 -> 2654 bytes docs/index.md | 22 ++++++++++ docs/templates/amwd/public/main.css | 3 ++ docs/toc.yml | 4 ++ 11 files changed, 131 insertions(+) create mode 100644 docs/articles/getting-started.md create mode 100644 docs/articles/introduction.md create mode 100644 docs/articles/toc.yml create mode 100644 docs/docfx.json create mode 100644 docs/images/favicon.ico create mode 100644 docs/images/logo.png create mode 100644 docs/index.md create mode 100644 docs/templates/amwd/public/main.css create mode 100644 docs/toc.yml diff --git a/.gitignore b/.gitignore index 0443cdf..b531afb 100644 --- a/.gitignore +++ b/.gitignore @@ -2,6 +2,9 @@ ## Ignore Visual Studio temporary files, build results, and ## files generated by popular Visual Studio add-ons. +docs/api +docs/_site + # User-specific files *.suo *.user diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index a74183b..de98e91 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -186,3 +186,29 @@ extensions-deploy: - if: $CI_COMMIT_TAG =~ /^[a-z]+\/v[0-9.]+/ script: - dotnet nuget push -k $NUGET_APIKEY -s https://api.nuget.org/v3/index.json --skip-duplicate artifacts/*.nupkg || true + + + +publish-docs: + variables: + DOCFX_SOURCE_REPOSITORY_URL: "https://github.com/AM-WD/cloudflare-api" + stage: deploy + tags: + - docker + - lnx + - server + rules: + - if: $CI_COMMIT_TAG != null + before_script: + - apt-get update + - apt-get -y install zip unzip + - dotnet tool install docfx --tool-path /dotnet-tools + script: + # Build the docs + - dotnet build -c Release --nologo + - /dotnet-tools/docfx metadata docs/docfx.json + - /dotnet-tools/docfx build docs/docfx.json + # Deploy the docs + - cd docs/_site + - zip -r ../docs.zip * + - curl --user "$DOCS_DEPLOY_USER:$DOCS_DEPLOY_PASS" -F docs=cloudflare -F dump=@../docs.zip "$DOCS_DEPLOY_URL" \ No newline at end of file diff --git a/docs/articles/getting-started.md b/docs/articles/getting-started.md new file mode 100644 index 0000000..8b3a794 --- /dev/null +++ b/docs/articles/getting-started.md @@ -0,0 +1 @@ +# Getting Started \ No newline at end of file diff --git a/docs/articles/introduction.md b/docs/articles/introduction.md new file mode 100644 index 0000000..f6ecaa6 --- /dev/null +++ b/docs/articles/introduction.md @@ -0,0 +1 @@ +# Introduction \ No newline at end of file diff --git a/docs/articles/toc.yml b/docs/articles/toc.yml new file mode 100644 index 0000000..8691378 --- /dev/null +++ b/docs/articles/toc.yml @@ -0,0 +1,8 @@ +- name: Introduction + href: introduction.md +- name: Getting Started + href: getting-started.md +- name: GitHub + href: https://github.com/AM-WD/cloudflare-api +- name: NuGet + href: https://www.nuget.org/packages?q=AMWD.Net.API.Cloudflare \ No newline at end of file diff --git a/docs/docfx.json b/docs/docfx.json new file mode 100644 index 0000000..4b7fdab --- /dev/null +++ b/docs/docfx.json @@ -0,0 +1,63 @@ +{ + "$schema": "https://raw.githubusercontent.com/dotnet/docfx/main/schemas/docfx.schema.json", + "metadata": [ + { + "src": [ + { + "src": "../", + "files": [ + "src/Cloudflare/bin/Release/netstandard2.0/amwd-cloudflare-core.dll", + "src/Extensions/Cloudflare.Dns/bin/Release/netstandard2.0/amwd-cloudflare-dns.dll", + "src/Extensions/Cloudflare.Zones/bin/Release/netstandard2.0/amwd-cloudflare-zones.dll" + ] + } + ], + "dest": "api", + "outputFormat": "apiPage" + } + ], + "build": { + "content": [ + { + "files": [ "**/*.{md,yml}" ], + "exclude": [ "_site/**", "obj/**" ] + } + ], + "resource": [ + { + "files": [ "images/**" ], + "exclude": [ "_site/**", "obj/**" ] + } + ], + "output": "_site", + "template": [ "default", "modern", "templates/amwd" ], + "postProcessors": ["ExtractSearchIndex"], + "globalMetadata": { + "_appName": "API for .NET", + "_appTitle": "Cloudflare API for .NET", + "_appFooter": "© AM.WD — Docs generated using docfx.", + "_appLogoPath": "images/logo.png", + "_appFaviconPath": "images/favicon.ico", + "_disableBreadcrumb": true, + "_disableContribution": true, + "_enableSearch": true, + "_enableNewTab": true, + "pdf": false + }, + "markdownEngineName": "markdig", + "markdownEngineProperties": { + "alerts": { + "TODO": "alert alert-secondary" + } + }, + "sitemap": { + "baseUrl": "https://docs.am-wd.de/cloudflare", + "priority": 0.5, + "changefreq": "weekly" + }, + "noLangKeyword": false, + "keepFileLink": false, + "cleanupCacheHistory": false, + "disableGitFeatures": true + } +} \ No newline at end of file diff --git a/docs/images/favicon.ico b/docs/images/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..dc2c5e85119d7db134b27c9824911b7843c37c25 GIT binary patch literal 6491 zcmdT}g;x~J*Iq#B2I-Yjmy+&UYNeF!Zlpv&T%;DHL!^;zL8TjsT|l}d1Oe%lkdj>x zSeD%%?|<=q&zw1P=ggg%J9Fkf_ntEV0Kskf4+H=%0E86)V7iqP4D>Xq$l1tmMJjDA z4Ws`?|Er|Lw~dW|wcCF^Uw=Ilg6T479st0C*Va%q30giXBndJ#Z5yW97|A~sE1zZ^ z|87JI5&HQA!cX?h(3?nhtXX+@rmCEGnhv6+zek#QPqUGSkpIp;#6d+Rk#S!u!!F}j z@Kh(Xr}aW^H$6H(711Me@e2!EzrepZV~BRCZ(X$WI%>Ul_tt>_Q{dtWihIB>xg#)` zMrW^Ax$oz09&3QcUd5XJ0UUPmDe0%oLw$#))spm>pjnm-sQYn zf7n>(x;o)G{Ri>2Fp%Pa*vt#(o8L@ysf53P`?(Ft@M-(l9bYiwIdK<>ypQ$#PC)>! zx3bOjS;oGS(v)k4bozoJHjhxYz~g zbmZjY5H_6mjjb;@`-iP8EebT!)YHQGI3>6}8{PmH@axA#`obezSCm|`I?ZYIiEGxdm>hfqKju>&Z zF(nl6dRjDjjURf|(N+V`?Lt#$gD8jWfLD{xoyffSzOXAq=_VQH6Z1rE^@TniiIf18 zEVDe}Wd3>dp7Oa6N5s$lVwY#G!0Lxl;QWFb(;AxvAM7r^HBG`{c+fEN@)`gTpg;#` zeBfl3T~v_RhPgi4eUe|=BcekE{-B}kNPHkBjUCsW%^T+%$}Qwd5x#UJa^O~T(G1QN zw|&wN`#{#7;1>T(I(x`!JQ#u$Oq{fdlz%`*M*yhYDkx_Cc`A~*yLZ;1C?TOQ_VHN_ zLCw%Zk0<>Gq4Lceq$;))7fXA$#-pb=s}8lzqQ&B8SKZy@Qk-nSi4Q*V@*YFY>?7kN z0P$f1(^{0TmU79&X9_Y{2NQZ;-luX)iXYC+wXl~I&7$<=3E=?5YiopcKd8;!1c);T zZw$gXy&ymdtix!38dk}JKAt$09U$h8Wv!aVxal6}yMgYj8kHG0R)N|fN`msJoi;>2 z!9VbUwbad)YLn{6j3sT7ay@Z-9TdTo$^5o;GE-r zMP>RH@s+~OI}ub+T+JPbBwUt~)KM`&YO>$S}8 zG{5LxKzc{e{B&W4Mg4sDmDYfjV`Svs+SO|3<68C*pGm=1(Vc*tj-|`8j;rUZX#g(I zck8^EtIE@1`{`mZB0`;q`GCsZtv}`^A(u|`jbEa>magC-d{l9uKS&)UA~>0K4^}F5 zMH*3!$SSNZ;FzB$zh24Bv3F?M^dpSYV7Nyg#if%BwzGRKwi0ZO+VyAg{P~_pq_dgf zppPtKnd-WkL2nT==L%i-W_hmhK=`SWfNu021E4iVDl-F&&tOJYiB80Og1;mcgerb4 z6zUV zOW%qfVmbaL)u2aZ^5RK1Obf2db-w)O+V`dl+U*)TdK-SZDihdHF$F|( zpDt!H|CDF3G|@%6+R@TQD1fv}eK8IMQ2}v$wom_>CX$RZ`w$Nxyi4EJxGiXj0j88r z-R+d5+~;p7x0~J(Gt<0C>;=5+t%TpHbV1y6x|ohMT+&(j=>f|8xZPwh!F{~0;BU=$ zoK`!Deq*ylZ=2PWu3ksy!>Fl8F(^@i(tWVSO@m&1=y=gyNj%n9!x~TML$gvQJH)$G>*cVakt5(i821GkQL z>gnKZM0h*6lG68q>T`-;a<#SWFms3QoLWIb{iNcfgvESB>Y@8(!q^()cI3PC`5m5l zX5KdZ3%zBkLBX&69zt&C?hl!0UN|Yv73RDAz{X&5X)OCo4nK7|*+nIviElfYw2_`S z6Xrra;&)nrGa+!fWD3`~?!{s{X5agdleZzkHpMR_E{8tVXPWk z!a&P+sAE*i^-nSWJT$a150yQz{<|>RX?JzUS#mos=5j&NJo@m^9caQ5<_WO3>xxZ? zNszIw(a|Y2X-iF9RKCIU=r9Y?7DmCu&*-KE(ixw!loRcJPI}`?1ABr!xgwFENMa!G z65j&z@0ZRC9<3X2^RPJjY)*M{10#Gbz64{VM!#)E_t&-TAX)t8n0(F`C(jCXD~KW( zs#{mVFBSA(JqHdF#`M?Ce?;O?+Nh91-{wtw7de0tFtIoIL)pD^la}tO#5`ZE(AwW1 z5@ddORT*<&+-dBC1K&LvmO3(s(Vs*zZ*)cD$A)9aRtMYC`uoA1(zUx;-e)kEZFqVh zD=dtkJ)GA}y{ADp>||aqQGg@*;XaEIBh-!rBBB-PXs&Py4ZeVtWPin$$TQ<)c!%?k zMxlr90#R}2NxsALkN=$6<^RBD9(n&%Td~NuIItMEXtuC#ify!WICrrfq~4&%x4bwP zisLG~vq}05^!OV`|As5PAlns+_idCd)r!Fvy)}==DhtH5e`vWoohsi-)JSJ;et&^` zL15v|96vUJ3hy+XNgcVT^7zn6gY3=!+OUEf*oE+ldlD_ z2Ug|DMmWfiT1~M{{oyGi!YREQDdDo*VGN!7+D{NaRLnqB&q(bc$@GZv)9U*9W)Bit zBs)NG*%m(91sg_7;S&8Ddfj`bzFLVq^>6^vNxmkxGJG#z48RgSI#fwh#D~Dyb=|Gt zIcJqbo@}^96B3JU%fc3HCdFgT5>z9?{AX>-4_p8dk#vS7wU8bkPb+>?CiMgnD=~nd z?WveNoTM%>mIX#s8rLM$OdXO6)266Q%h1OL60_yI$VI@M{M6{a+`w)q(~gxS06!IS z=CPStEU-bFKFu00TjOKV@<_cztM8T6(fF+`eKV&pTwiG9AQ|N2xlCFMXO)rYS!;Pe z5NBT5!=s6y-Y{x?IzV@CjUBy=BwDa-cO)bEJM)(4u z8R}T9cH((Sz+pDkB#9hb{(wxQO6lK4oV(kd)tehl*n_}j+fqJ!jGCqek;Y=_OTe-3 z3-gwKmO~-QX}pg`T*IyQXE{0lmGs_&>k?{2`)~B}+Ku4Ya9+g@2*lPyWb2aeCnO(n zFxf|GQDG3|g=fI2h1c_rY_97r&zgIovG!RSP)E(zdTw?l0TXf&`RZpSBzH{1PTjAD z`v&moN)?lr0TpAg-7=+`wHE2Y=lm&IMy30J7cPbUw_cKmWe*4$Oai-(!2&$XvF64= zcct2d@h5IETxJ{ysSZ3%%p!rsC>ZweH+*J>4QFoB*zvqV|G>&V=`P4YJ|bx0zK{u@ z_hPu_x=ycp{#!P%hu&;&$eJ*M)S1-`aG!n3}2X1u9E2fp&Rl#wz4N8c17!L4wAl9x^rpCC|8-5dBL zdNfIJFj`))_bnsjas2F;!Kp)y!K{_p&>g{-7ho>*QvIeygTaW%4YGyX$C=JF20tQT zMA5Y}dHLAK6s@q%MUwLLsN#DQ-v{{zoadtU|HvpYPm>rfa3U|`{nlCid?rc2_nmu; z1d7)6-si_bC}O^z4oe7Tj8vH(0jO)aT1)b6ff3(Bl?iRQ>lhY2#~ZqTW-xTDR(;nz ziYDqPfa^K-4CPH&4a?hjDo*ST^ThNooS~Os=qnswAr*e6m4o1{p_z!54dg~K5~`va zT^K=nP$=H=UZ(#lSvGB+;r*N5ajR*6Cqp$lr3*L|bVco3`DX*%8a2Ovu`EVnU?#la zy!NT^UQa`kn#6J9x0LDFVpqyDS^0)W((8=N19MBkN#Ok?y2PNKb-6Z%{VsEZ)>96U z&++!mYnlz4mS^J!zn(~~i;D?I%Sz^-1bEtF?i6XHB`n={|1%;X5ChMmsz}RsG1Id=lY_~QpeH{L7@n7RPK8FMI zMhEPINometvup3$7rXY$&1&JA!8QuGf~Y}~ADFsnZn*QAPet7=4+I)&(en0XpS{nr zK|Dzz%uDD69NDb%wcI~c2;xt)t4?8V;AA&+7SKviz@9;>o*&SsjK|O~E zsHY|boYPJ$w0*JjU|vGupJ)@s=N~}0q=aG7c`Mai&?3~hgH}Jv16`DS7u29Pso&c) z)J!C_4Rw1+z6~SZ{#vrEb3AGQuA=Hx4vTJS%@{qA*G@y&cPE|w{#3#AN(vbHI6wN^ z(?0lEX_@hh`rK2_Kd?^H>teMg8uCs@bCYEcXOU+O>hsU3wi0nB8e4Y0L+L{NqCNO$1{*8vNYw-nRM&KR5A zJX7OmRF!7t&(tc&;U}yxVe|>z<#qN=(Klm{ScA8ea}YN>0l|bHMny}N{#MP)BS71y zyIE}hQgX5O`YAFi8R)2x5v6@glyGp;ZQLEPzYVE`KU8r8;MCqz_1p*ZZWp|Pn6Ox5 z+MM_rLno&q6@<2l$*}kz7x~n9*);l7;?nc)TEC&_0BgR%Pm{IYun^oY)5W@!u^3?{ zKL>75QD^EKI(CZ7&vO((BT`5ffme^^Vr_>#-G%F8QLWT--JmfDn`?eCP`&~_5J^{%9Xll5m)G$CnT*f1n!kHG)tU>b!zz#zG) z<2WBJy5EePUzH;CYS> zbCtD@KNschBXhGLYqy+j5er>=i4takti|~15S{1lgQE!z!-Am{i$&nRJc71eOY3a)hs*xwMGf)Lkwo$qM- z4Li!GNCks|YTHYspJnA%h=jc3jfbVS{q?Pw40~HRJTUZkX1^yHG(z#UnP}fhlKXCf z`bZ%{>moBH(auy#Me;I}Z4)*pf1&ffLq_=zlLuhyxT9_VjA!8+&zjk5I+3hZx3Wc> z^?|Pb-XBA1Yj8d3vP){5M(=<%62iEic7#;;s!m;Y23&{qGK2(`p8Os}Cvg~TiYRO0 z($%}?fNAXu*s1OA4!x0py7jO`)2HG3WM52T5#jZ7d~Xu&eAp3tu+~0jx;^$q^gcXw zI&kFT=j_faDtZh%k>WSgwaGwKC!g}LSH8RRd8Cz| zboSUU)eq^B6hRm8YMVP7;_hd1&Gc*yV%@e??!)iCLLN;i&e`$m&!|XPW9`-x>->~haju{P(?iSWa@F3 zZ?I2s4Ee}2ZhW6Baz&;%wCiJzHb<}e@)q-Cw1Wi)f=@Sc&bO9e$J`2oSvg? zeJOOy$LSB%ecXJF;62kH6osC=PuM9_*>7-;!M$zBA~IdLAt2e{$aZ;$qUY@dmG%0@ zx#iNHvsT1*O_#92>(6)TVD_)0Qydp{t6trv0G8uRx0@3s+FIEwWwzXfx$=f1L^u40 zR=Ah{;7s|m@RYypkaTmQ>8GL~Mj)NVoXSD{brR_E`B|aiLh^&6jHYXSd*u%;tTcJC zFS?H5V`o`*-z!yfN0m{Bcrhj}#;nD#t36(}OpRWi!;bfUTHvLh`-5^eY++Rvxik*@ zA&%ciybkf*QG$WlDKGpPZ=Wz9j>l#T>O8=RxB zU+<(zH|y6>;;OYZH*U->VHC$#>TQ31ax9wulPfr}w6~Wi6F$PYRyGzjaj3wAghpPZ zMRXJfO>x6UUj*#fS6Phg6(2NwhgnVg=?}hr>wU4d4i6q@PnQCp_;UO7Nd)>W)>li; z;MZ$j{JT+a^If_hT-Y6K+pJn_?c_RS&zH&Dj~8Y+zq@37ih2Qg=5{?w&-prBcOaT5 zD6-O7O!c)Qar`I958X?k)HGHUmq>?@6?!yML|u~5U1?cpRNNbEA@mwuSWiqr^7k-Qq>Y(^ylMN&-d5sM`Wpl5b|2B}BK1j!wSDH=3+*!924;&}JsyWa=>0RfHGTq~=03jP}W_2?`64P9e+2{84F z(*iVA5M44RkvFYe*(BJD?WA}`sO$0vv`Cv;T<^;u7Gv&nZx z9{In6+g|`zx!t0Rxz|%Z$twWhdBq&o;#SaebmpZ}N&{wWShXt9_?xlA`4Z`JV{kKO zUe5K~MIf>*?3>ux*KmWDgXQq4Mj+>m^yK0A&>H9i7Sw+JV@DYmZ}mza+*+M;BV`+k zTCXfQQ1@;Lo3g$t^j#n~W@|7Ovm+6fVCqg0u=8_iH{y`RULU1ab6NiP!|?wd-xTpQCppRIG|9&`|D8n}qNh=( H=J57^;bR)~ literal 0 HcmV?d00001 diff --git a/docs/images/logo.png b/docs/images/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..ef1d4e1ad42143b821e3eaaf7c0a865b190f2d36 GIT binary patch literal 2654 zcmV-k3ZeChP)j00001b5ch_0Itp) z=>Px#1ZP1_K>z@;j|==^1poj532;bRa{vGi!vFvd!vV){sAK>D3G+!rK~!i%?VEX! zU1gcZfA4p0ZxF&J5Q~^bO(}#yN5e8jgu4Z0vrtH*Mnq5CM$nK3A1f>ARhBw$D&NvD^jyYKxT|2TcSZ-0T%Ed+|Be^p=A zInVoiXSwhBma|-Af-%#*;H~d+&R+=3!ZaQ15Tpubn-HtOmL22|ddS+>41{%G2^I`8C?)KkDM#w-`cLIls6v2bN&!>##tDq;NZVIoO;L2X2RC$-KOTx;OM_{;DZu6pso z*KT?y42+kFB)tS$Le%?Y>yOR2B#ey}iA|C7xt8lTt_x%1VZ2wz0YmST({6Yr2?8)< zYE|x+TF`n}7#j~0NqP~wzdUU=W?u;PzXyZqy-wc>_3Rh+^!vu?`}Gz zJa!>XXVVxQWRFc-OZfy`Whx$Ip zA~OGYvFW+rgb@G?J3_Lb4Bnmly0mBScEBX5@5{%v9vyKu*sJn9Z9HUV&h_r_x0rT5 z<-=IORfBhDuMNfhK1n_8t>^SzKkYY?)&ut#929!?CGPE6HJo*w1F(bNJci%f<`3L; z<|*~c7%IIn(E?mg`?PPE@u09%!}va@=@4ad|L&VV`a`o!BLH^7Wv0eM6x68$@*!EPAra|~>+YW=d|TLOXi-XGsQ=aE0N zzqX{__Tx^IF)!5jhE)fQfxZTIbw%p$M*TbGySG-ft7}kw+XsEm^Pb&Z*zO(1?yd#~ zdmC(bcgFATa_a9!eJ@n2yLME3e|N=P25V^ABSEN&y4H!^&rAK=VPL0I|Mn{VT~WQw zz-7#xQ@6hV@p|10)f1g~zHhqlmf=R=pMOIBcQ=Xdr^nbZ^!r8f%w+Xjv`qb1Z|4}AA?@?B5KuUh1g zA78H}`fH2(U6KYPYYMg31v9y$PjLF?1A13lwDmI(WnyD0g6s82A#1QYDX4EL4!e10alHo>t5&-lphEU#GczxC!^ zv3L>EiGnA}aeQxmEWiqd!feUTlj(3^ovN9imCMWjQg6!TW@m9eYqG6LQu+=+p-?#1 z!{q?GGnrdDmoMK2aAvW1ij&R(FqtH}l(AL0S+gE%Z*L#<;4+`jzguP()N3`Wnaq!V zwS4(T(tWjgI03WO9i`G;p*N&ZD9n-UWHZ|w$1A=O#sTvA;yjt^XP3PWR>g5#28NHb zSS-G$Dt)ldH;hTQCrPp)pU=Ou8b!`XH@pbr>R=)vp&L8m`0ARFD-?cV*u{c7I^xo$ zb>3lS%xG&oX37gc0~>WSDQQ5)mE}0Tt)}Jk#V=tjkXX}^luiW5<#MN)i#pRvetME5 z>qswRs2rcP|ada~JU zvx_ntfj0p{{)8k+)`q@ZzVN)69U1DN`;s`mu$HK7q3|h(-5R<8kk2Mb@<={kTqIMY z%jb)8hn{g6=wZawKnXCz=H>Inx#2eU#xciin?IBw3GNWOM&b!GYc%oQw8g$6xaY+iflHU z!MK9-QoE%iE?wFY$2Z7VW+81fvq)y24(p8vN!yb+zA{NlZ8FlU-|VC@zOK2c;bXuq03uBZZ9o-l zZLLVQa>a@jPXm-nr9YL+||iD zGMJf*^j9;R+}zy!$P7i_>X8;s+1*ar-|3bV6;9_0V! z#m2BSM*DCvz84xYhAjaW2rkLx3V)K^a_4lGycU|7lW`63;HX++YPMKBzqabUe=13m z)t#N4yYl(M{lG;S^K-evwkWbEs?t9jq%YpY&qp?7Ylj+dYpzhZTFyN}RsTiWt!*0| ztkflRs0OrTi^cOJX{s0VhJK;H_Vx93gkGROiAyJiVu;D!Tz@_p*ib5!{*SZ^pJK+v zL!l|@1S{RE88dRZ*@cdd6??W&V=+=Q*yklR7_15{q~|#hIeU0SF|yh0Vde73*F$dS z!7YnHon{u9v#+>F|AX<>p*LUgmd%@Q9@#*O8F?q}uN9enrY`nxf(^hVb9S2-D-HWB z0OGcej?#TK@2*`v_Y2mh)$9i6^=mWE0x<06a=Eiba(AId(E0r|5{ruk%Yx$ zf36wgIDRHFW(wUXSPj~U)FI=NBq@!WG<0@$?rMnKnMmK3SR?6aiC-ZuPmb<}- z_4^!}JzXnbJ^qn6PDWe(W{Cu;JX+s_7d;=$M!F^0@e+y9q9jQkjN|yBIF28Z*}`-m z)>1!#Fyqnm`26OjOP3C)>Ml#y>6&!tq36|nPVU)ozqOJf?M`d_4QaELFwjsnYybcN M07*qoM6N<$f(_v}@&Et; literal 0 HcmV?d00001 diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..a3bd3bb --- /dev/null +++ b/docs/index.md @@ -0,0 +1,22 @@ +--- +_layout: landing +--- + +# Cloudflare API for .NET + + +## NuGet packages + +Here is an overview of the latest packages. + +| Package URL | Version | Short Description | +|-------------|---------|-------------------| +| [AMWD.Net.API.Cloudflare] | ![NuGet Version: Core](https://img.shields.io/nuget/v/AMWD.Net.API.Cloudflare?style=flat-square&logo=nuget) | Core features to access the Cloudflare API. | +| [AMWD.Net.API.Cloudflare.Dns] | ![NuGet Version: DNS](https://img.shields.io/nuget/v/AMWD.Net.API.Cloudflare.Dns?style=flat-square&logo=nuget) | The DNS section of the Cloudflare API. | +| [AMWD.Net.API.Cloudflare.Zones] | ![NuGet Version: Zones](https://img.shields.io/nuget/v/AMWD.Net.API.Cloudflare.Zones?style=flat-square&logo=nuget) | The Domain/Zone Management section of the Cloudflare API. | + + + +[AMWD.Net.API.Cloudflare]: https://www.nuget.org/packages/AMWD.Net.API.Cloudflare +[AMWD.Net.API.Cloudflare.Dns]: https://www.nuget.org/packages/AMWD.Net.API.Cloudflare.Dns +[AMWD.Net.API.Cloudflare.Zones]: https://www.nuget.org/packages/AMWD.Net.API.Cloudflare.Zones diff --git a/docs/templates/amwd/public/main.css b/docs/templates/amwd/public/main.css new file mode 100644 index 0000000..057f8d0 --- /dev/null +++ b/docs/templates/amwd/public/main.css @@ -0,0 +1,3 @@ +#logo { + margin-right: 8px; +} \ No newline at end of file diff --git a/docs/toc.yml b/docs/toc.yml new file mode 100644 index 0000000..b7532c4 --- /dev/null +++ b/docs/toc.yml @@ -0,0 +1,4 @@ +- name: API + href: api/ +- name: Articles + href: articles/