From 83f42c8047de568449639a5fe903706840684947 Mon Sep 17 00:00:00 2001 From: Engincan VESKE Date: Mon, 5 Aug 2024 12:07:14 +0300 Subject: [PATCH] Update docs module documentation and mention about the new features. --- docs/en/images/docs-referencing.png | Bin 0 -> 7457 bytes docs/en/modules/docs.md | 54 +++++++++++++++++++++++++++- 2 files changed, 53 insertions(+), 1 deletion(-) create mode 100644 docs/en/images/docs-referencing.png diff --git a/docs/en/images/docs-referencing.png b/docs/en/images/docs-referencing.png new file mode 100644 index 0000000000000000000000000000000000000000..fac16500ddd1700e711c001cb3f808c437c05bbc GIT binary patch literal 7457 zcmdT}XH-*Nvkof03IaAjKmu5)qS6!u1Ybo!Pzk+?bOMP;NPtjP5Jh^I-g_sZ1cIP~ z^qN2d2}lbegiu2hxOu;C-TUwUyX&s?{Wxd#o;mxhnKS!L+0UmJ`dVBZf*b$;m&=3>3{R?DBk_wd2)(M|NY$mto?^)Hl>9Z^OZV$6RkeTS<oS9; z23{wtBFW6&07v!Kg9iiT(;*Qodk1N;lL{>AE1+=(01y>DaR&eh3Of6P#X6>W_Ba4= z>eTzo-aNu2u-$(l&THb#IKcQqa;0#*cWd zgg)=6iiR{^$=jHulVQISsWpMspEjcp{o%KJSRcs4|1v%{@HB0f@uBXX)STm92+H-b zDfG-4>Y4}~cGRV^2{*+YN=95dXAr1Vsr6Mx-4C++o3;XfcmJySk4P*(z6kk!4`11? zJh$LAmR+B3gv{F}xeLd^aXOxv+_ah_ps{;x>QwmN(QWM`3LB?w?I~M8&*!+?t8m6{HXu?`@|Hd>-+i+8!y4mla$9Oah~M;7uH7ZTn^4nrzgp(WL2r+m zyP-Nsrv8}h-eXqBLaRSS9y>g%=;!uS<*mL|t!zO6&Oh-qYKQEWZdxRg(}G& zcV9^Do+{nKR;%52iR$RzlWOD4j{!Ptw|e{_O9(lQ1ag-PAwIhrivD*wv%{VQ~!rI*RAyndLtxc`6`+0Sq5UNz=s z20_x-&`uj&0y}oc04J{chgqp5Ldq8%qwia%yO71h@g};&y1JI5l2X}vEn2q#YG_xk zxoO}QeW`!;9`tD}y!Ywk?ZhgLGWS#a9%rq(eOG!5~FT^n3c56x0rKmLgBXQFd^QGaoFXkrJn{6@!FD1hkkYk-_8RVMmQvD)Yg9$#vU{U;33?Sq znKFB5DP-(`2}1a#%6!PT5gu-5gp3}&i>~Ocna7gVjxy=0GIMNzL18Li+Je=qHfm!< zhY6y-U*3k3x@IAL&0l){Z(pA>U>(h!qBAh}@ya9b1>S4aetAaQn%I+#&mFFH5Hj{W*@#`=*x7@BiuZa~&Ek`bYd^T&MGf;cGu=V!wT5BtJMbjIrN@*v= zSlTn6Yc};6hpC;S?e{bfo=p#|$=GTV^iP_a3x#z_oVwCA^@$nigzRy<)u^2J8-8Fa z?a=CyUH0deMv1j)E&Q;)HC0?S$X?V$Kt-jaoz07yC-dol9zncHq$cC6H> zipa-hZtQ7qWHNRovWWPUbD6q~#%!gj9rL_ym2y|9uUkWI{yFm$;k99f|H+gb14+Y^o{`Se`lk^o2) zJsufF-&b+Df>J$G+54vjT(Z?9)KbwM8QDKMF$C;xWbRqlyI9A+XV2?uuFfF~%0mm7dg}tr4;%n*zB-w2lM&Q79W#obSpd`tJ z1hadz>0W@=^SghILY_9CUC{0oUC>Ux?Z`fhj=p;+h_CwD=esn3zAW<52t0;(a25~B z)Q!9O_j|o?F)>oCwEOt0kS++>XYvrTp9adE{kGy=WhN(S8Mw!EBsGYZ?S9PrJ!bJO z{NiMEfu$4j3e&2$YF+}Z`tjHLpCRD>3)4VG%hNA()J1|_6w$6@0_ zZ+r~g-(-G24(PWgk5^0(x2`g?`s-eyr>~dJf*$$eg)Tt6@Xb_srmABobf-7rea_fM zCVJ4xYZlFeB!`_nZEN9nrA;&WrpNo_LibA+Lu*|I&oSYed-N8*ioFK)2v{rcZH%=O z`)Z6z8Nk0%FRQwJbK@L@n1P(AC&5gXJyaGx!V2kn@dRM#Hs$hqPd=Suo}J>tP**$z zQn>VnTNkvcoq5+wC)b;$9R{k}aRr1imC2oYyS#0*R%hszRLu(}bXbOY+^tCi*M!(82Dr!Wo7=zqc{|Dd@HelEt?f(*>qY1ODMI@-+2%nk`hQlDo`3iqecpj* z9~){Pi7Q)IR^oS3c{eWbJInYPTEyweW-MksD;0{CaZXXcW*3ac5CB1P+7UWOF6rFz zMEen2cbmGe^j(u5EcFC=z*9ZCMys>cf-wS|!Y1G!QGwYZQivy~b;N4g&akW2 z*>BpqJEHh1yW+P`B8*o2OHs7+@2<{o5sS%!mapYuRT-VfY3c;PimV-i=B; zo6^1;+CRV~Sn<)wLWHq-jouBO!Q_1>aVcLd&85BC&B(t^LqTHM?@iwyya<#>qL?C; zKTD}qk^wHZ?$`a7SUQ7~m{Zu0cq+}qZJLM<` zjSQ*lkSeMyo{5nVoTIDW+XtrShp0q0S^$E8jgBv2`>sh2v!n;l_bwYX?aq&!I`yqM zK1*Y{s+(U1hc#8Q&xG+Nx*K-sQFS8NE9Wk9b>A}h*>qoUva@d^V|!4JNYMkD7d{xX zr&@7zt1LFT5sPyY?>J4Fkj;#yjTa2}k`}M3Mu@l>bv?rjs3>;;GgB1ILZrZ>gQIOUz{7XSRc~E;n6AJ6q@z7l zib}4xzUY6d1f8?zl_r$zC5m0guH>mGVeS{ei)%=T-_ zE1W=+63EFj-~_6*=Z_yYMRW7!6CFgwsXn3DJ4RA!Z=T;TpIF^tg}qBYzCW;9Hyb*C z^3<#&P>-<#+;#hEcPovI5090Pd%U2lL=k15_tao~W!6b<)Rn=EmB7TJjM3Z-Che9S zxQQdM1*gQ*_K|}WSWcg7e@Vr0h>clvL)O_puoMLkvBez&%OCc3y z&pctZRa^0K{c^Eo)}8wh0_p7&Y$~Rch#+hzjOGK!a?vXb^)`qIk+C9IpO_jgJw_9m z9;DP}~I<{W^)qtD+B!G!16E-k|dqXDSxTCO)Uzo zj6A{R+(dQiWj0?Z(yCW2GZVsi``JY#9&Hq?h>Q-^fqowT)}vn@$#6<^wLA7@?fEZJ z_%ywKGM>sRllU>z{T{TSwc?bi2y%Wwxulu#ETj%UICvx5Dy2dLj-pZXiM;!4 zNINp{OAC{MI!L+St>d-L_D#U~g|$o1J+jpR1zeTNpo=odLZn+xGLht?1-mgVh}KR= zR)VEnz4}DS^(g!k#z;ta6QyfsXL_v1Fpcgj3wzNM=-&1#wT=>>*pXp(Qs0oeH>H(X zyT4uH{id!7^GOvou^J=kk=dud0$EiR%IPt#UEI;q!ft)|jNe(RWay85E?=qjIlk{{ z<(W>A)kWpi#6grwN7jKzBh1yQF0i>=pNWU!GHxZYg4hq+s7-sQ>YLTie|N;Gw7r}` zqUkDZ2wF@PkAVrZpm;pVVW&!;fj+SS<2`)7?Qgbgrs$bx(6UuuXXtbK_S_w@_v7b| zqNay~V?-W~86?0zrEb#Xo;6~jgeg@*gL`esYbgmi8<1?2{z~cOWNgC-#L8ZMCs+q= zHy8{0SiJiCzKl@Po{Wkz0aL@(`G-H3y>d^%y|staN1-x-*4RJHRLjYt;Yl!B1`F>Oj#pkcT+#V)m`Iib-&EF zukGF=mPcus1g1C0?9YAwC#CjVnh^qvp>>Ft4}I%r99z0`1Er2hW%Mu z(#-x_a`8xj5~0yo*n3J3eP^e`kIQRhZKcbuWZg?QGDW$IE+LFhg;e%=zG{Sux-Q4o z$^)_7z|p`4?bdjS@Ve!KP3JaU{g+Eh~_~>52Cqv6U$~YuD}ooN}b( zT?TUk_q+v@S`F z3lh&qEPS`U`|>ke@>Q_`yBf#+-6IYvLHY%$kzUUO&_+hpkgj-%Zpf1ed@d!*&|}y0E5+-PZ}V~0?xd2{Lc0VX+zEuC>t@9YwX}@A zb?7Uy8S)fEm=m6>w$@$HH^Lj4NbRrS(l0j>_E}*ypIeAJ0WQWJc@xGMQ^Cf1!)T{B zxa~hkNq$L$tKT4YOtld@;%n46;o@^ap}m!#B31N=(z>*lrhAtQ^*3;)cKCY6Y)$}BKtG#nr>azb$P!tf9>##T%A1vrG;+7yil|`aCb#}%P zoETIQO{iPl@^m@^wsVnJ?N6ShjV#Evj96(?xUSwn1zdMLyJ23dyIj;3_UlmPe6n_+Z=(2g(R{Qdr|U-R3OXrq_Rn06(Bb|?;!doiALz&FBm zuSxp|7s4UbXy}J#x%cdwKa&PqDD#b;>h5(^bY5hWq8e}FmI~Ij#>QG5A&>nCSu&NYMk8R!oPbTf zDUlgwCTcQpVc&Xpwwn@#Z$|pH@NTJ~=J3^PwdGM6C680NO9T2I$b3%EEIYa=(~MJk z*fRmAG`J%caNUhiFh3=JDdQXZH$Md&!>CnQ3D9THB{>NxYJ|*V@r{iBq2}eFzjC%4 zfU0Hd7`Jp^im=KY9;I?2&=JdMc1|Hdsim^AhAT7aCH2cy2SYaEw30;{mw=*`lto9n zlXDUDsqYI`>7No0=A#Cx#!M|SwBf&0M1Fm*Eb%kn&owo-42Ub(#Ynf@>irFA;)MoH z2_}5m;LVBj{>a^V9*)?`EV7YFza)HbJb3iwVYLTf6_)_txLcl*GPL#5zw2OhJKS4n zbb7)B)<_4YsW$a-`|z+gaEbVhg`3BWJr;I~m7^5Bb~x`8nt>pHez zuse`FW+gEuZHU{8{YC3g)73dTGp}munC+=kAGydDRBQ7&lzf+qOOqEJNFsqpiHsg0S>}5`-b$nq7@`)e^GE(vNJQ#Mz;u~WE4-y|cRr2Su71rq=?4{_QvVD4~js>vv10z17 zpd;oo`+bfr*2ouJF`&yn$N$KVDX6DpV*-?i)2)P`p7}RoG^oHj2mTL*Vq(9hrjo9) z4jFtw!~A;xvPblq@cz2463eC_ay)EvoIeM79stPNz8<0}=I^_ijQN-3{C(H;#cI2~ z=9t?oAZjo*R#R+$>TrKz=t=uOkd&;B!FZ2tV#jjR?~PpLbt=X6b?-kQmdmVzjI3t} zx5%!=JvWK6MnbIVoXzH5GnOK`JLw7QzwbYK^V0_Q7yyuVM%K@N*C9@@b;p3*7R#Z1 aBvLV~g?uOYwveSRK>M-&-xZp#-u)L?k&h4n literal 0 HcmV?d00001 diff --git a/docs/en/modules/docs.md b/docs/en/modules/docs.md index 6aaf1f2f0a..f321b00e2c 100644 --- a/docs/en/modules/docs.md +++ b/docs/en/modules/docs.md @@ -666,9 +666,61 @@ See the following examples: ``` ``` ---- +## Referencing Next & Previous Documents +The **Docs Module** supports referencing previous and next documents. It's useful if you have a series of documents that are strictly related to each other and need to be followed one after the other. +To reference the previous and next documents from a document, you should specify the documentation titles and their paths as follows: + +``` + + ````json + //[doc-nav] + { + "Previous": { + "Name": "Overall", + "Path": "testing/overall" + }, + "Next": { + "Name": "Integration tests", + "Path": "testing/integration-tests" + } + } + ```` + +``` + +After you specify the next & previous documents, they will appear at the end of the current documentation like in the following figure: + +![](../images/docs-referencing.png) + +## Single Project Mode + +The **single project mode** allows you to use a single name as a project name in your application. If you are not considering supporting multiple projects with their multiple docs and instead if you have a single project and want to have documentation only for it, it's especially useful for you. + +You just need to configure the `DocsUiOptions`, set the single project mode as **enabled** and also define a constant project name: + +```csharp +Configure(options => +{ + options.RoutePrefix = "docs"; + options.SingleProjectMode.Enable = true; + options.SingleProjectMode.ProjectName = "abp"; +}); +``` + +## Multi Language Mode + +The **multi language mode** allows you to show a combobox that lists and shows all documentation languages and configures the related languages in routes. + +It's enabled by default and supports multiple languages, but if you are considering only supporting a single language, and don't want to show the language combobox in the sidebar of your docs system, you can configure the `DocsUiOptions` and set the multi language mode support as **false** to disable it: + +```csharp +Configure(options => +{ + options.MultiLanguageMode = false; +}); +``` ## See Also