From c8bdf0fa9ee0bb2b6d9cbb144d20b045bf9c8f4f Mon Sep 17 00:00:00 2001 From: kxrthiknair Date: Tue, 31 Dec 2024 23:09:23 +0530 Subject: [PATCH] feat-UI: SM-Docs-API-website --- docs/.gitignore | 4 + docs/docusaurus.config.ts | 84 ++++++++++--- docs/src/css/custom.css | 156 +++++++++++++++++++++--- docs/src/pages/index.tsx | 6 +- docs/static/img/logos/github-dark.svg | 1 + docs/static/img/logos/github.svg | 1 + docs/static/img/logos/logo.png | Bin 0 -> 5468 bytes docs/static/img/logos/youtube-light.svg | 3 + docs/static/img/logos/youtube.svg | 1 + 9 files changed, 222 insertions(+), 34 deletions(-) create mode 100644 docs/static/img/logos/github-dark.svg create mode 100644 docs/static/img/logos/github.svg create mode 100644 docs/static/img/logos/logo.png create mode 100644 docs/static/img/logos/youtube-light.svg create mode 100644 docs/static/img/logos/youtube.svg diff --git a/docs/.gitignore b/docs/.gitignore index 7dd4990..d8a6577 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -20,3 +20,7 @@ package-lock.json npm-debug.log* yarn-debug.log* yarn-error.log* + +.yarn/* +.pnp.* +.yarnrc.yml \ No newline at end of file diff --git a/docs/docusaurus.config.ts b/docs/docusaurus.config.ts index 485d610..0c85687 100644 --- a/docs/docusaurus.config.ts +++ b/docs/docusaurus.config.ts @@ -49,10 +49,10 @@ const config: Config = { // Replace with your project's social card image: 'img/docusaurus-social-card.jpg', navbar: { - title: 'My Site', + title: 'Talawa-docs', logo: { alt: 'My Site Logo', - src: 'img/logo.svg', + src: 'img/logos/logo.png', }, items: [ { @@ -62,9 +62,39 @@ const config: Config = { label: 'Tutorial', }, { - href: 'https://github.com/facebook/docusaurus', - label: 'GitHub', - position: 'right', + label: "Mobile Guide", + position: "left", + href: "https://docs-mobile.talawa.io/", + target: "_self", + }, + { + label: "Admin Guide", + position: "left", + href: "https://docs-admin.talawa.io/", + target: "_self", + }, + { + label: "API Guide", + position: "left", + href: "https://docs-api.talawa.io/", + target: "_self", + }, + { + label: "Demo", + position: "left", + href: "http://admin-demo.talawa.io/", + }, + { + to: "https://github.com/PalisadoesFoundation", + position: "right", + className: "header-github-link", + "aria-label": "GitHub repository", + }, + { + to: "https://www.youtube.com/@PalisadoesOrganization", + position: "right", + className: "header-youtube-link", + "aria-label": "Palisadoes Youtube channel", }, ], }, @@ -82,27 +112,51 @@ const config: Config = { }, { title: 'Community', + items: [ + { + label: " Slack", + to: "https://github.com/PalisadoesFoundation", + className: "footer__icon footer__slack", + }, + { + label: " News", + to: "https://www.palisadoes.org/news/", + className: "footer__icon footer__news", + }, + { + label: " Contact Us", + to: "https://www.palisadoes.org/contact/", + className: "footer__icon footer__contact", + }, + ], + }, + { + title: "Social Media", items: [ { - label: 'Stack Overflow', - href: 'https://stackoverflow.com/questions/tagged/docusaurus', + label: " Twitter", + to: "https://twitter.com/palisadoesorg?lang=en", + className: "footer__icon footer__twitter", }, { - label: 'Discord', - href: 'https://discordapp.com/invite/docusaurus', + label: " Facebook", + to: "https://www.facebook.com/palisadoesproject/", + className: "footer__icon footer__facebook", }, { - label: 'X', - href: 'https://x.com/docusaurus', + label: " Instagram", + to: "https://www.instagram.com/palisadoes/?hl=en", + className: "footer__icon footer__instagram", }, ], }, { - title: 'More', + title: "Development", items: [ { - label: 'GitHub', - href: 'https://github.com/facebook/docusaurus', + label: " GitHub", + to: "https://github.com/PalisadoesFoundation", + className: "footer__icon footer__github", }, ], }, @@ -116,4 +170,4 @@ const config: Config = { } satisfies Preset.ThemeConfig, }; -export default config; +export default config; \ No newline at end of file diff --git a/docs/src/css/custom.css b/docs/src/css/custom.css index 2bc6a4c..8491107 100644 --- a/docs/src/css/custom.css +++ b/docs/src/css/custom.css @@ -5,26 +5,150 @@ */ /* You can override the default Infima variables here. */ + +@import url("https://fonts.googleapis.com/css2?family=IBM+Plex+Mono&display=swap"); +@import url("https://fonts.googleapis.com/css2?family=Inter:wght@400;500;700&display=swap"); + :root { - --ifm-color-primary: #2e8555; - --ifm-color-primary-dark: #29784c; - --ifm-color-primary-darker: #277148; - --ifm-color-primary-darkest: #205d3b; - --ifm-color-primary-light: #33925d; - --ifm-color-primary-lighter: #359962; - --ifm-color-primary-lightest: #3cad6e; --ifm-code-font-size: 95%; - --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1); + --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.29); + --secondary-blue-900: #001c63; + --sidebar-bg-color: #f3f4f6; + --secondary-blue-500: #3970fd; + --primary-blue-600: #1e56e3; + --base-neutral-0: #ffffff; + --primary-neutral-800: #1f2a37; + --ifm-menu-color-active: #1e56e3; + --primary-neutral-600: #4d5761; + --ifm-breadcrumb-color-active: var(--primary-neutral-600); + --ifm-link-color: #1e56e3; + --ifm-button-background-color: #2e8555; + --ifm-button-background-color-dark: #205d3b; + --ifm-hover-overlay: rgba(0, 0, 0, 0.05); + --brand-color: black; + --next-prev-border-color: #e5e7eb; + --ifm-font-family-base: system-ui, -apple-system, Segoe UI, Roboto, Ubuntu, + Cantarell, Noto Sans, sans-serif, BlinkMacSystemFont, "Segoe UI", Helvetica, + Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol"; } /* For readability concerns, you should choose a lighter palette in dark mode. */ [data-theme='dark'] { - --ifm-color-primary: #25c2a0; - --ifm-color-primary-dark: #21af90; - --ifm-color-primary-darker: #1fa588; - --ifm-color-primary-darkest: #1a8870; - --ifm-color-primary-light: #29d5b0; - --ifm-color-primary-lighter: #32d8b4; - --ifm-color-primary-lightest: #4fddbf; - --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3); + --ifm-background: #111927; + --ifm-background-surface-color: var(--ifm-background-color); + --ifm-menu-color: var(--ifm-color-gray-200); + --ifm-toc-link-color: var(--ifm-color-gray-200); + --ifm-code-background: #001b66; + --ifm-color-content: var(--ifm-color-white); + --ifm-navbar-search-input-background-color: #001b66; + --ifm-table-stripe-background: #001242; + --ifm-navbar-search-input-placeholder-color: var(--ifm-color-gray-200); + --ifm-hover-overlay: rgba(0, 0, 0, 0); + --ifm-color-primary: #1e56e3; + --secondary-blue-900: #c6d6ff; + --sidebar-bg-color: #161f36; + --primary-neutral-800: #c9c9cc; + --ifm-button-background-color: #25c2a0; + --ifm-button-background-color-dark: #2e8555; + --ifm-navbar-link-color: #9da4ae; + --ifm-navbar-border-color:#2d3956; + --brand-color: white; + --primary-neutral-600: #c4c4c4; + --next-prev-border-color: #293441; +} + +.main-wrapper{ + background-color: var(--ifm-background); + display: block; + margin: 0 calc(-1 * var(--ifm-pre-padding)); + padding: 0 var(--ifm-pre-padding); +} + +.table-of-contents { + font-size: 0.75rem; +} + +.main__content{ + background-color: var(--ifm-background); +} + +.menu__link, +.menu * { + font-size: 0.7rem; + padding-left: 0.5rem; + text-transform: uppercase; + font-weight: 700; + line-height: 1.5; +} + +.menu__list { + border-bottom: 1px solid var(--next-prev-border-color); + padding: 0 15px; +} + +.navbar { + background-color: var(--sidebar-bg-color); + box-shadow: var(--ifm-navbar-shadow); + padding: 24px 48px; + height: auto; + border-bottom: 1px solid var(--ifm-navbar-border-color) ; +} + +.navbar__item { + font-size: 0.875rem; } + +.navbar__link:hover, +.navbar__link--active { + color: var(--ifm-color-primary); + text-decoration: none; +} + +.navbar__items--right > .navbar__item:not(:first-of-type) { + margin-left: 0.25px; +} + +.footer--dark { + --ifm-footer-background-color: #111927; + border-top: 1px solid var(--next-prev-border-color); +} + +.header-github-link:before { + content: ""; + width: 20px; + height: 20px; + display: flex; + background: url("/img/logos/github-dark.svg") no-repeat; + position: relative; + right: 8px; + top: 1.5px; +} + +.header-youtube-link:before { + content: ""; + width: 25px; + height: 30px; + display: flex; + background: url("/img/logos/youtube.svg") no-repeat; + position: relative; + right: 8px; + top: 4.5px; +} + +html[data-theme="dark"] .header-github-link:before { + background: url(/img/logos/github.svg) no-repeat; +} +html[data-theme="dark"] .header-youtube-link:before { + background: url(/img/logos/youtube-light.svg) no-repeat; +} + +.footer--dark li { + margin-bottom: 0; + padding: 0.5rem; + line-height: normal; +} + +.footer__icon { + margin: 0; + color: #fff; +} \ No newline at end of file diff --git a/docs/src/pages/index.tsx b/docs/src/pages/index.tsx index 270b7f9..2211f84 100644 --- a/docs/src/pages/index.tsx +++ b/docs/src/pages/index.tsx @@ -1,4 +1,3 @@ -import clsx from 'clsx'; import Link from '@docusaurus/Link'; import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; import Layout from '@theme/Layout'; @@ -10,7 +9,7 @@ import styles from './index.module.css'; function HomepageHeader() { const { siteConfig } = useDocusaurusContext(); return ( -
+
{siteConfig.title} @@ -35,6 +34,7 @@ export default function Home(): JSX.Element {
@@ -42,4 +42,4 @@ export default function Home(): JSX.Element {
); -} +} \ No newline at end of file diff --git a/docs/static/img/logos/github-dark.svg b/docs/static/img/logos/github-dark.svg new file mode 100644 index 0000000..654102a --- /dev/null +++ b/docs/static/img/logos/github-dark.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/static/img/logos/github.svg b/docs/static/img/logos/github.svg new file mode 100644 index 0000000..ab49f99 --- /dev/null +++ b/docs/static/img/logos/github.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/static/img/logos/logo.png b/docs/static/img/logos/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..62ab0a91c3d8e2482895fffc61276eaea44f1c3c GIT binary patch literal 5468 zcmbtY^;?ut)7~YPB^RVoS^+`Ipc|HwTBIbU1ZkvMkd<&r0SW0w$pxfiK{_M^X^`&j zT;N^5_xlgtAI^EM^UOVSW}cbz%zd3OEe$17A_gJ=06?mute}m3_WT=Q5Oyv#KxF^` z)a)t>vO3;ryMNyqyqahrI0yif%aD`P2eT0ov1y#zrb{vvp6NNFZJDFx{hOwx#*1o| z#2*yz#_3HPYL@C2ZyeTC6I74;LW|k-Iv2Hhh#2G(Kf}z~yi7_c1EbMe{)xu9t0DD6pJ= zzI0Xf-0z~<>{l-rc2I$pO1#ERb_;9zL@E>7-k)gLFZid7h5s6}#U9LQw28A%!ep3? zNuZncve7usPz)bqqiR))XM@sqfq#KKKne zqxj4bcCg9b{bo~8E!QJ;8xV<^l#v}=+jZ%nIdAd#g z_jt2)BaU7yxGckm?rMr55gI~A&WXDJlc$CE24~vP8I@}O$;Vsg0paEP%Q`3UJWQtl zQG^-D!y2&TW?_~Olu@K0d2!pOjO9VoFhXU)crPnDss13 zj1SWV?PtYL_&t|zsV7Poc!-pZ_`3OnWck+`=xGZ1iRFgxJ})=W`zZk54FpAG7p$%R z?wgdDRn6%1V7~~(8DTJmltym6xVN&K*5UE&;uFrum-oricGT!Pr%%)a^1aE0#=?Ql zTr9lxsSE_!Crs)mc7#rhjBQwKFc#ZaEMM;wNZK#IS%0_CK;b6`6kHwby%pFn#_Fqs z?I&&BsK{S&2QY)ONy}0i{T&1*)E9_}LLZO$-277J;CQX`jVzK0n zqFw(5?|fUqf<^lNyIL~p@}Q(s4(|9KxUF~q#P3K_s-3a*9Yw@kDonipizk(Zpd)^e zjkPbdz9YLRK#AW$Rnb`9y*?M);`SG>ISY}rMEPhPD_*5c$8K~Hh+`4%Y(^gpXZ!-5 zPf|nOZ^ef6szI|JFVx*wxSeKni4XEy)Og54919(}_mNCqWB#`?5%D{YvU=>tCk&Is z`$$?@<-0J#7+rg|KYu4S;kZalr2G;`iEDw$`|I{wgFma{dj)zCFg-mQ_oWU(Lr;4U zk+OZ;Hx4-#bm$x)?eUS_mA3EJXrTz-Ogk-A%s5{3uUBEXc*7BC`rcW_o0#qiv2=|l z$C;Ys2SQ=ATr7?kx5DV8OSg&A5|nK4@};IEn}VT%0bP1>GJQWZ^`E2R9^2!*Pm0`i zZRQrwr*qnco3cleFlC8MqVKK9w$Ba-@$>Kt3kwC$_vax%7D?~+`}xsnGZ;pAyiYgd z*O!K5b=rj|n8R*nP63B|Wm+PUIJf01nk2TfWE0kk!>y*%r(Z@ot@M zFpkB_!D73cIokvEm2-(0uH%p{4I4XMuFlCXd(l4{Jcl@9Geq6itc|L|hPYS;FeiUB zD?B_rG91x+UASHjLkIGu)6KV+dphElFMTIC_q?i*8s90M|28D-MLoAPyK8^I{p5*z zZ-4)T2tD8EH77ll^4m1&_rK~|YF^MG?s&F>2i9*6l^ut1ee$7D=rBD!y}NTB1%4iE z8BeORZFnWtFw*&HOry!ED9Ks(!DkB@>0T)bAU9GSgVrme^L6|Y` zq!yxI$?KIEu#RoI7nj0jy4543krU>V&pceJThX0czMOf~aJHL70tSahLMu#L2=Ro1 zqGHj&4SuY$w=?HrI>j_?OsP@r;1h1{a7A&XzN0Jk_Aq}rQ;@vQ#_sn|lY!?y`T!UZ z?L+xMyJP~)US)mp{`z{Y`)XeT;aan4C~$EdL&($H(*v%7iU6`?*YRG55m-H9a&a5a zZ4AIQ260ocj%16wgFiCyam;CQq9~M>ZI3bH*v#!bcq-W8JJUkX z!_AHJnNeKmqLbDveyS-c{rv{wAt&e1N76R)64UKqDrcM7dpB^6creJDj^rQ^cn_c& zszpqpZ|kDtQ%4Lrbeo29XwY4L-kF~g{j*O7=oP>Va zgwgZYy~esGCu*N$yc)N){v=Of;P14xNBpome{9ElC@CqamaTPy6Er8!{}dZU`P>;yJrf_%=#bS);I`!2QOjl^e_HbWZb zx{>x|6fq`^p6W$qHpi2e35`tQ;I|X_0bJpua=U#T@xEx&CZFTC$fQG_3xt)84g9UO zH7RcH9J{b0v5>x~=12no-{0XpESaKEE_=h{7IP_}hhNWjfp{R|@&-s3viu>2Ea7&R z*Pw;DM9G@gQ@%7lo~pG>ippK)OI#dMM_2cA|@o9%D>ZRh7z{Q8*RUZg`<9M|(Ry12ntUdp4(RYRYuJ{n=5W9H^qKoYcORp`>mj zxfeV&B*ZDq?ygl|(I`A35=s3~7W9yvoxQHEPUM~%2RlQ|O!TlM(UFuLX2k+Azcg5IN`vuCRF|n(& z^N}JH`WR@=S5G}hzqt8gbEeigb9lrvC$Ubb90&>Ag)@(o;|Q`Hm8L9sR~VE;L`6x8 zxGr@R4+O{n7YSdb3iVh$y=zB8hDu9IPd`xyYA=45AJ@8WI1_;85oCz3hiiD~(W`f# zZw#|LZ;s?kCzU{fi^y@$7gH?(cay}ld>uj`rn0j(pdjN1e*n6i*NtZao!{kxZJrsk zZe0X;H7T&cG&3YFk+JMb+=jjs_`#h0Q)lbH_*?wYRaMWa7{Mwqep08in#^dA0SaC( z#acMybS}FT2Zy3iz%54J5gmi&Wovs89#)_pKs~*Lx+!9B!*+Zk6`Qal2Odv)(M+SenYV8yK*vN z(0hsbzI&hr%}vw+%BkWy0zyR8aDz4fVJ5cyAG!R}EyOJ0?Q(K?yw3TYX*oK}wi9Gb zS6mZush7Bc(F&H%m-c97+Fx4ANft1d8@V`Kt`zrmz%o{Y<@z=I36y_jQBk(}7QTL?5#e9-vX26c%WJQO9pPAF-Npa}BJ%R`DmFJaE4aPTCre2n4H~(rz&s|p z433XHY0@bot`^!34kfzZ!oY$oWN2Y$qi>p-8RO(j98)mAG!+rKSq#g)Fc&3Vr$1tL z!YsmuL0_+<`ob73(p|vRLsBJH`|ttheH}c3WDT|eX*

@B;cpz)B6D9z#)g3sXMY zaa+t!3HYuvB@O+u@4g)lef*d1D~Omxk-gd>S4(r}5P<}ooJ4LUYeJQ#SID{CgHb9M zQMGWsWig-ExK0BozpQMR?D#V6fopnKu({2D)k3q+nm9V$z=x2f*R5avJok&PEsKU9 zCS!P@a+WawLUe-O9YGi4q+i^w-IwI_Cj+6u2-)ppNQt!;@+%h$$4;G(pPl(%Ne-SB zHc5F@^Rz$4b$Ne?G(vrIm)>t|bl+e`UcGd_TiEl@X(%BTIc4+XTWfqel2Qf4PLNdP z?fA%$K6JpCOcC9)2&Y{$E$Z7}i2D!{fn#BHn83R|<{Kp*qq-hO=XhMWv=w2J;-`t-ch8LDqjaq{`Ocdr^Gy?SRSxBa7I$sq7y=vtH_6T1Lkk({*Jf{>?=IE}pM< z^S*grl|p-l>B>kCoR;)@G{U1G$>TmNB*0+juj_K~4CJws(N16mhxJ9K_Fcz5u?wlY zq~;IvE^PnPH@_$8sD$YF-jU*Hr&9fGP}A3c9sa~_>KPKEybOIDH@AFKK)-L`8{_4x z31`Lzw=xnrMW0aLN@6#~izMrjoBF2C5R}+CxN#?EQKP{Gy*FGc z2Tmp39dlyC^8M3crSNiKUvQB}U<-PiFH&DphZ<#_=OObM8QB(}FCHHk^f}VWv*{TV z<=|j9w1Zu&_-F6khKx(09y0_vP1=aU8Q&MIx&V6%`bjnT29ih><0zzep4k_cer{Ph zgi1%4;{8D4=aMDlMZbal$`CP@VYs{Zl-^JsLXXbP^onLMqNdxVEqzmcMgB93^papg zpukf90XGX_h|=1uUIMhdV61bj*g-clnXm@c?sCd%SEZT>DdR+8t(l6b$%Jq1i9X`i z{`zsus>9Uvt)^nt=>5eVJ?3xmZwH$Uk}3PL5=~r^5Ppf3UJ>J2mKA4)QXREk(<`28 zSmf*;7P)lTK!KdvXl2Fu;(k6m$paxyHh$9(+Oc&7y^I#+8_Mp z_XIvt%3LRcGLW=qylo}fOJ`N`_2|~a#8FJ{o&DhxyJSn{T8Sf@ufHY@ znhT{mTZhG+Ti@s#&s0#>Y^$sW>`hBsxBnED0t8?^r1G<&B+u5yGF za2~}L@W|?<_Q{&jYm455;M2{7sqr}y&AEZn2n*{`v#-%kHL72*&F~vjYt57G%*^}* zvs64DG_0Y{H(ibK_)@|C!LRX8>875tmcI?H?=y3TTDdhuYZ}anJ0TB;g6YU*O@oqt zxGv;C#!mxwbp!PGsSG|GatB-=t`Rl~v~(-jmq^7c!9(^YZ)WGalZcR7g#1Ug*Q^zFF5yT5M4Bm(X$m&`}&e(XcHZU;uYbC{@?uZGIz0*rKp(6}w!UT*Joc|RvLU5)Kk zl%gW3EFf%6&jNik>u=BvljnbSn1yLa6FRaO+xci?FP1tFQ$HDvNb%+ATOoO4IWduE zq=Kutn5&Fg3ERW@0iOzT+$90|CziNPaJ}98&0Ayn6#M~CT;Ho8edNgp|D95WYdz+^ z#yanGW6EQ*;{nqD^LS&@ZG_fr>PK^_60^ke-08w%EVE{1o}=-7|Fd+n1Thc$xEiW>$pi0&bROYXa$DP1OWQ9*2Xz6+^;6phS}h52^1(^9Gy z51Sh`)6Kl15p9s`eq*r?;U87(-82?54?IJy`&OKWOvGMz?sj}_Ae{-~M6w+Teh}=w zWFlKQtc1Y5@z!44Wf-iuZ&ow$`&}M`H+dNU-(7FW$ZY-5wxo3LRAs)J3F8jiz2Zx6 z^SLj_)WU6veYLkF0JIpsnb}{jy_}7~Y#L__O9zvJw+-GlUS8PA)!;eikyQTO-|bZs zJ@EoY@BMRU{qqf~B%5BR<1TE{|MyEq@M7#80Yw#$_Sc*-W9+RdKn1FyfRcL?_#fiP BdOrXF literal 0 HcmV?d00001 diff --git a/docs/static/img/logos/youtube-light.svg b/docs/static/img/logos/youtube-light.svg new file mode 100644 index 0000000..03a5666 --- /dev/null +++ b/docs/static/img/logos/youtube-light.svg @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/docs/static/img/logos/youtube.svg b/docs/static/img/logos/youtube.svg new file mode 100644 index 0000000..97a6123 --- /dev/null +++ b/docs/static/img/logos/youtube.svg @@ -0,0 +1 @@ + \ No newline at end of file