From bace433df0a121a3f65c003f4108bd7610a301d0 Mon Sep 17 00:00:00 2001 From: rweesner Date: Wed, 18 Dec 2024 10:21:59 -0600 Subject: [PATCH] update wripple docs --- docs/index.md | 36 ---------- docusaurus.config.js | 141 ++++++++++++++------------------------ sidebars.js | 2 +- static/images/favicon.ico | Bin 0 -> 15406 bytes static/images/logo.svg | 30 +++++++- 5 files changed, 80 insertions(+), 129 deletions(-) delete mode 100644 docs/index.md create mode 100644 static/images/favicon.ico diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index 44f841b..0000000 --- a/docs/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -slug: '/' -sidebar_label: 'Product Name' ---- - -# Tutorial Intro - -Let's discover **Docusaurus in less than 5 minutes**. - -## Getting Started - -Get started by **creating a new site**. - -Or **try Docusaurus immediately** with **[new.docusaurus.io](https://new.docusaurus.io)**. - -## Generate a new site - -Generate a new Docusaurus site using the **classic template**: - -```shell -npx @docusaurus/init@latest init my-website classic -``` - -## Start your site - -Run the development server: - -```shell -cd my-website - -npx docusaurus start -``` - -Your site starts at `http://localhost:3000`. - -Open `docs/intro.md` and edit some lines: the site **reloads automatically** and display your changes. diff --git a/docusaurus.config.js b/docusaurus.config.js index e5ffc77..26d5bb2 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -1,23 +1,52 @@ -import {themes as prismThemes} from 'prism-react-renderer'; - -/** @type {import('@docusaurus/types').Config} */ +/** @type {import('@docusaurus/types').DocusaurusConfig} */ const config = { - title: 'Wripple Docs', - tagline: 'Get help on Wripple - The simplest way to automate your applications', - favicon: 'img/favicon.ico', + title: 'Wripple Help', + tagline: 'Get Help on Wripple', url: 'https://help.smatechnologies.com', baseUrl: '/wripple/', onBrokenLinks: 'throw', onBrokenMarkdownLinks: 'warn', + favicon: 'images/favicon.ico', + organizationName: 'smatechnologies', + projectName: 'wripple-docs', + themeConfig: { + navbar: { + title: 'Help', + logo: { + alt: 'SMA Technologies Help Logo', + src: 'images/logo.svg', + href: 'https://help.smatechnologies.com', + }, + items: [ + { + type: 'docSidebar', + sidebarId: 'helpSidebar', + position: 'left', + label: 'Help', + }, + {to: '/apps', label: 'Apps', position: 'left'}, + {to: '/tutorials', label: 'Tutorials', position: 'left'}, + { + href: 'https://smaipaaswebstaging.z21.web.core.windows.net/login', + label: 'App', + position: 'right', + }, + ], + }, + footer: { + style: 'dark', + copyright: `Copyright © ${new Date().getFullYear()} SMA Technologies.`, + }, + }, i18n: { defaultLocale: 'en', locales: ['en'], + }, presets: [ [ - 'classic', - /** @type {import('@docusaurus/preset-classic').Options} */ - ({ + '@docusaurus/preset-classic', + { docs: { path: 'docs/help', routeBasePath: 'help', @@ -33,12 +62,15 @@ const config = { }, theme: { - customCss: './src/css/custom.css', + customCss: require.resolve('./src/css/custom.css'), + }, + gtag: { + trackingID: 'G-7XYMFXX81Y', + anonymizeIP: false, }, - }), + }, ], ], - plugins: [ [ '@docusaurus/plugin-content-docs', @@ -58,85 +90,12 @@ const config = { sidebarPath: './sidebars.js', } ] +// [ +// require.resolve('@cmfcmf/docusaurus-search-local'), +// { +// } +// ], ], - - themeConfig: - /** @type {import('@docusaurus/preset-classic').ThemeConfig} */ - ({ - image: 'img/docusaurus-social-card.jpg', - navbar: { - title: 'Wripple Docs', - logo: { - alt: 'Wripple', - src: 'images/logo.svg', - }, - items: [ - { - type: 'docSidebar', - sidebarId: 'helpSidebar', - position: 'left', - label: 'Help', - }, - {to: '/apps', label: 'Apps', position: 'left'}, - {to: '/tutorials', label: 'Tutorials', position: 'left'}, - { - href: 'https://smaipaaswebstaging.z21.web.core.windows.net/login', - label: 'App', - position: 'right', - }, - ], - }, - footer: { - style: 'dark', - links: [ - { - title: 'Docs', - items: [ - { - label: 'Help', - to: '/help', - }, - { - label: 'Apps', - to: '/apps', - }, - { - label: 'Tutorials', - to: '/tutorials', - }, - ], - }, - { - title: 'For Developers', - items: [ - { - label: 'Developer Docs', - to: '/developers', - } - ], - }, - { - title: 'Other Apps from SMA', - items: [ - { - label: 'OpCon', - href: 'https://smatechnologies.com/products-opcon-automation', - }, - { - label: 'VisualCron', - href: 'https://www.visualcron.com', - }, - ], - }, - ], - copyright: `Copyright © ${new Date().getFullYear()} SMA Technologies. Built with Docusaurus.`, - }, - prism: { - theme: prismThemes.github, - darkTheme: prismThemes.dracula, - additionalLanguages: ['csharp', 'json'] - }, - }), }; -export default config; +export default config; \ No newline at end of file diff --git a/sidebars.js b/sidebars.js index 0d9bad3..206d175 100644 --- a/sidebars.js +++ b/sidebars.js @@ -5,4 +5,4 @@ const sidebars = { helpSidebar: [{type: 'autogenerated', dirName: '.'}], }; -//export default sidebars; +export default sidebars; \ No newline at end of file diff --git a/static/images/favicon.ico b/static/images/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..03e75ff4bc4b4c1e8e04036ad59f0b46d6c2b92b GIT binary patch literal 15406 zcmeHOd3a6N*S@Vr$UKz^AyPanE8yZbpjYeZ?(IIs-jQpzOYE6$D#8}MD-JAfr%KqOHe%0D<|1f%U9n(os(!#sDzxiG=ghV2TE&f) zclwU95>kn7XIvMDer?XNYd+$8=_j~2@1`ob8E5#94V^ghmxg@nda5{gg~@R|Wmk0- zD{FNV`@CjRe#RXkigVNX@NX^n*t(8foO6v0S82g*KC#(}4=riLg?BIVog5*C&!?g~ z9voJ?8y^@lmkMrW3ogmK!Lh5}=c6m%cc`Xe5cm-^TIg7*%bN%=QnKfF@kEBX@Xd7BIFq(GAK``X9Shu^_U!^Pk`sufnc|3{eZmtkH`GRu_1mDB`UY=4e_n*mk@|)8bYlpFv zUCou2nKw3`fo>M4)<_6Nw-%4V^R^rEreD~9OQu_Qz`E`3xg1I9*!w1c*ob)cW zyVK_Sz3FuQo|IC*r*iQLl3KqPovGc8wp(fSu9}a8xjHG|WMlJA!q&t=)U5ousQpyw zENYo`h+^&dNkv7usO0RYKbIjEk5w>WjnMCRoM<_*9O;`XBo| z65vxYcKZ(|v2(xeaHK<@eGxV;6l&9zHd?#TbUDAwJC!ym*8%Ngt{HdYhGvf3qnaDd zZqSSNH}zC5wi=||as4K)Xzn;SoxiUs1^F6N&_p8nq>NTnP`Id6-AJ*kqGcH z7E8T9(e)a+ujt*c=x*}?%H@W=DYAyUev!Ge=wH#Eo60q!qLv$Dzj3y7;q`SqDCvVC zl%e&eyf0@_iSPV4z29_aW!GdQ5j^>Ih>_Si#Y*g)TJ7;N#Twrji;&5$iQq}Ei%rwo z(ewp-^9#4a|j%6B!spg&p-B0csjW#&dw zR)r943ykGmzc}%pX-2$nh6#r+sK?Q(yKv0revg&Ie$ISw;hVgFhAGOt!NChYWPks? zylyYi+%2RGn@`I7LrGuFof2)jvM<_pvT)%^)xV(Sjr!6BS0B=CIzUR&Ri-N$BvQ`C z@{x5;ynm(%M=q?3Jx9w|qpXI94^=RLikx|+1JXMR%4yt`QBHQHe?>@V-ktlm8_h?SHRtd-mWUVHVb9yA)}>dNPhVvEb_wax*3J4o z#cnG{T4m)d{2TNZ2R|P}H@%k=olL>!Xq&L-y{z`-{weEBx=Lc&I-)M$(VZs!M6{I? z`CDs6=$n1`u=9AjJ!Or6j`;ZgCEJhxU90y0&@T=6bYNf3zIw#)`fvBVTc`Ql?r*TS zH&*)}=ht5Czv08wbis2r3wE7A+08vgoNW7P?dPN)@q8wzKS!bMhy^te>viT^ z=YzPcIGYuH>4SP@d{kDP!*?!+^T}=9)Ndnyt_j<@@ZBpB55AM_&qe>;(Ek<>_5Vrj z=VzYdq_DAkbj7=Ta9&l!dGGL**hQRo>#VASp<-QWKIdni=j$ieARhdf56rPayxCHX z`R-khGknJXwEd!cX?!hy6`u;|i&)Q&BYv&}AMoU>$Chwb>R!&daa@%2S*HGDt1N!j! zeWM_wF)s&loZo*iPWAWz=KbMcoAJfNGcbRSacNujo{GBV2d~VOz7>Cvv z+nO9cw+ei`i8?NFY@(Mo!}wI=2suW}-&WU&+sUC^g7{uvR{X;46Dg{n$@7DZoi81p ziP+m7V*&q$4q-DbR0*GL1H07aV{1EbO5`NO)S)cndp%-uQm~lazn*0OC(VCDIlZn} zJ@4F2JIt4k%t8OY#JboO=b28b9N*-u`bBEgk2nh);G*2?tSc)p6n}7+?f;YcZzw4H zAay7$yu$@|Q{i**>Ul)^os_#*qEtVWXM)m#OxU~#{niGqS1><|L!2VfwOW5+Fov{ z72eg{c?sg4b57o*TeF*#Q>jeJ*GQyg2v+45?k^%Jf90m&lKFDA0=@8N=1BbJ%A zmK2=t^{}(9ikmotea9QIZf6<$NgXV;w4x5qZts6Z*RU7nc+I8~*h(3-ShX4B_dga{ z7UyxrYYvsV{6M)M45jpX9(2mmnbw;-u&a!DHEr0WQfIDbj<~d%yD}B$#LzeUQVML5 z{k9kBT6&Sv@=M|u6NOMt*L)!5Htt84>i3|q>TdLt8E_TZZ%sQz|yg# z6Y!JoZM6Djh!MA1YB|KxiS}4JD*IkYWLYhRTDkCc8`u};iU}4tR~tL9o$R+E{MTr3 z{*b!htSfC|t>u=M4rT9IIPwP;_T1LIi|)f05m{E&VQJ58teyC68Sf(IuA;$tLv8a< z1z!DnWr6<_3rL&<5Uu7*$Sa%#MtF6-vcNMffc-+lZ>U(O+(#VQ!n!kCT55BxE$nk` z+IeiZ@$~exT{@zc?S=^&Rf2H;Z$+(Zgt_em&rY`X9;Vzm}4b%&~#BT zv`X09j5L}Z6`jPg@wofn`_`A2!!1d#722A?ey}x6hHT~+i-s)|s z)q6-x%v!5=Fn8hhX3nL}Og<4c(FaRS{j^Gd?F0G)oUrmoqL$HT+(P1YmRe<~wU%aB zyXco9X7H=wn*V!;KD+(L3?CM_dVIrO+k7m7{e4V=1AL8w1AX2Ic~SA7U>vf2LZy(6 z-c^IAjC2oj@m%L$&pmT1+FlFYmm$8GZRM;RE&F2P%&jYRF0QBcK^+G<3S2?coGWTR z6xB@~xs`=8JHqB8fb}n_;ZFN&enBT{c2klY^vp}QAGqiCxRFEe`gu3Z+3sVO=kHrN zFVMGQUf@Kd{J@D7?~5_+&l349%J>@P`}nd!AX zD5X|+$6e$1p~edEt&2;Shvx)t`gu|S;a1QPJ9FSC9p{qzcd4W z3Eu0eBEOM%rZMCV71M+b#5Nxr`uPVp-8W;`mpFc#S@6-bzg6jiso zev7Ru&9ZdlL1vwGA8Vv9fsd1Moy0t4>;*>+)#niV(4JftT1ht-1)E zS^@Hg*!^Qg@Q;>a_pCZ%&)lYB&%Bn;kY-}f?D}H&3>%a+7Q0c;?kT`^r<#eabG2gS zaz8PDLncjJP5KcFN!R;FD(f^xDZzQ6utqn^wC+k_R=_t+o%u5pEw?e#au10+S9PbE zHM?^-&S2S}j3PbGoXRZVy(@N+vMG!xC^Aok>-5A)f86TKim7{)b z#WCw$_(Z^Pj^8!rsd6H41jlXi;OOOTIedOCV7TVI_a|cp-^!s&wH&%*EeA(tifs`@ zt8wO>2YeX)P`ZpIJ$yPJ^YIwYgo|-D9BAe&xC7b(7cS+CgqRRMvc-$T=2qwZv&_(bb#Sb20kd%Dq{wNUo*2X#DF>b^H_nIh z#Unp+LV%}=yG1Oh#bL9|(GLqg9Pt2fWQk`=?lp1u*PL-~JFu7=e_{^?4C0Zy#H}P2lYDR@A6wrM_;n*-RJOnd zErFxEa9aFY&d<#fMWsR%6bo@Xo5cPo6Y+-|9yxzzFt&JNXS5$wFY&Yq7>| z1a`h3d`6P}SSt8o1?l(165RoJYQW5Or3IXs63SuBx08ce z2VC!2mjX;B`|4r7c<4tyzOj>vDIc6)MXm1yaMkov>r^~Q#WsMK9 z6}K5eR~iFj0S~+x`uj<&#kQ*mXwr|O(Z5UGCsNULVBz5>n7|3E@QK7}{4 z2FK2mShSr8bGfv`NJ?)pfa0pUi6Gd18?cgK=)b$UC&hjKEnV$Dol3!}h^Pc1WZz{y zQVjZ^RqZdaN-OwJeU4q-me21U#kZ4oJ)ix7p=Do<=G3UEz`Z|%|GcUCkF4)u`y1LV zh9AWz3-MbJi9whH4&T!)%!8BF-FUCmUE=&zU3qVd0elR371svLpwjuj3ywY|IKK#r z-@o+04Kq`A1G^p!%)b`&w+60TN5xvt!T)bv2!j6EhR>gPS1=zWE|?NAk>l2W%u$OQ zKz|!PIM;^b!6``pDJ#13pnOT0;FBqWm+uk`zD(~pmTtW}m=dbHi~RKi?MEx*Oj(z5a#u2mkX_ z`%BJB+B$kkLtxsr90~42;@xM0Jo)CC-+{5-2KK090eo6@y!%#^zvVOeP6s|jaxWM5 zj{zqB4%UL2s{ceTtjP&GJov_$O^?-o1?-Q!5xo=akNx;>_HPOQk@^pOqW=_vhdIbe z2gYN~Y@=f360?{5Vf9&dW?xaeY13DygsGl6fS0tUF~z*=ml=%`;p0%q}nN z9gSi4>Zqd*A70iBYug~sIKKnm-8B?tga16Le~m}{=UMtI>byIGb#FSb{w^w)A@`nx z*nf|${|xhSI{Z2k`7fzzA0EcJC0`(UsG@sU_}=wcz5<>me(M+5M^GO8gzSf$3+MNL zr*Z@jufs1*f8g{vH%`FLOZhbXMdl|(B4;RUmL(rq(MIJ5Z=71M&dvO+^J*V-CAr7} z%2n-IfIO(|YcZUWxSf;2eW35B;2*7F|C-2uYJ>bC555>Z6Js2q<_#GJ;HBvg&PV1K z-MX+7?aWZQuOrJ_LkA12qjuPfy72kkBf!PX;`D^IoC&T)`nik|d z2mj}eT&HGyU>0Hq*gpPuH%`WSbOU~s3$9Xf2Zrlq=`a1E7`a?I;4U-H2deG;0lx{K zW2JJUvJWvU-$&k=GoOWTCu5$ZL`+g8`JfLch7MEbN$l!&D(8K0E@B46P?CQ;w`U}D z->i;L(Y>pG;Xq%O{&GI*O7qkhC->GVaGKyB!8;$q9u_{^QjNi+J>`6s+}j_B4Nh!! zROR?ad+3R^5;<)LW?O*^MC^xglWWh3EzW#7W}Z4PigK>P*Y2tO$;-CCTtgJh0d*cC z*H7lgT{<$0Px<#$=U(*Ex8TdwAT_Wy*}*@Wa`dtm<$@f;s9zd^Kdr?PnD2+s54ms0 zW4%v~@WprrsOyqkpHzdo$UoY$%qt0PDrw_r_2j?M1ol{j6RriH-V;A8z8o z?}zpOZ{nW^6-xc(T);TXK1eRV2=gHiIWjV?mwfiEq+q_8xPxz=-BvDG^X0mmmAVgo zJp_MAQ2Sk4cvp>URog%0GY_}*Ed4E=#4cMG5!!5kh(%uLRpbSi%-KwcpXo30vy5jA zSGg}?oG}h^ZzZMd0q?6T&Q-@n=Ag>l*^>O5>Rs~BI;<@+j+Gp-EF*0$>v+^>WLpL? z#LvqRKO+ZAXa7BAv>wFqh(Gs8-EoH5ioCcTjr&qm`{ClEn-3L9p7g-+KhH0Qx(xb1 z=`Q`tVva&=*dXA=%WeJa zid6mYbK~+1b@(*VPssHJ7F7&9?J{`S2%H}`SUHK6;K~;OYg~+c^nfOP=``}#@`f!S z-Ijx-q-8K6hgjsJ4ta*hSn|^Z-*8b0Jwu+S4zvl}K(?KpNn&>_DZrp~|M`Xrp<^;~ zkwf7#ORSuEF7VD#z_i99*X}nwKiX^n-E*HvI^=^XyO0-m_%zdToIlTA65{+7!K$R; z{x8Tm)PL@>VA3z5OK>)a^+LHM`MzYZoydSm+27!7SuGf>YKO9bae6LJgMGDT%%DO#7fl(xO9T6N12|4=jh^%|(VZi}tYr{UG#r~vB z@e_JrKl+ZNNe3U#13nm2#Z}A)UfA2jfwd-GfJr;(+FLk_VOCn&0&MFtIQbmlrv+}l zR6H0t0^S(A*_(-EKKaj5wvkx4jre7XtP^$?z|F+$O+*t`l3rq$-F%f2V3`HYJShkE zy$)Xw#kqaFnFD_U%=w*4z@m*i@|ze3CkvUQ+m-w=21k%zkO(X*9eMM2yHBD5$B*u)KUXP0Q zrA;e$6m`^``gX#`v|C4Y<~ww!@W@c3+bYcctwx zMYJ78{BlLssnCaL_hu%dx+)8efBnURC>T~-c$1xkS7cd zpq%sS$W=@o%36T8>1^Fq8Cu1a7F2apf{{BC1D{L8{JvJ*oieJrE4T4H3v%ZrOO~u# zwgE{;n@Px<{-c_kvRD4kg-uswq|EU!f}Npz4V80wz=MH50$*o>=W<+3krxhpv>$R# z#!C(f^J1aQ!?DoPY71xbLp^ID>t3>~RqHNqV*^A<^O@0JLt79U1Z(r zJk&c{B8SP!kvp1WZ83E!d)v5UiJj&HVXNlzYa|c(xJ&Yq_x(w7Vv=K$`8O`;mlVlk p{%?tFPqr;}kh(}-w_LZ!aHo&!%d2OvEbz(#uPpG&0#CER{{U9M@wNZ} literal 0 HcmV?d00001 diff --git a/static/images/logo.svg b/static/images/logo.svg index 9db6d0d..dcf25b1 100644 --- a/static/images/logo.svg +++ b/static/images/logo.svg @@ -1 +1,29 @@ - \ No newline at end of file + + + + + + + + + + + + + + + + + + + + + + + + +