1
- import { themes as prismThemes } from ' prism-react-renderer' ;
2
- import type { Config } from ' @docusaurus/types' ;
3
- import type * as Preset from ' @docusaurus/preset-classic' ;
1
+ import { themes as prismThemes } from " prism-react-renderer" ;
2
+ import type { Config } from " @docusaurus/types" ;
3
+ import type * as Preset from " @docusaurus/preset-classic" ;
4
4
5
5
// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)
6
6
7
7
const config : Config = {
8
- title : ' Talawa API Documentation' ,
9
- tagline : ' Start your open source journey here' ,
10
- favicon : ' img/favicon.ico' ,
8
+ title : " Talawa API Documentation" ,
9
+ tagline : " Start your open source journey here" ,
10
+ favicon : " img/favicon.ico" ,
11
11
12
- url : ' https://docs-api.talawa.io' ,
13
- baseUrl : '/' ,
14
- deploymentBranch : ' gh-pages' ,
12
+ url : " https://docs-api.talawa.io" ,
13
+ baseUrl : "/" ,
14
+ deploymentBranch : " gh-pages" ,
15
15
16
- organizationName : ' PalisadoesFoundation' , // GitHub org
17
- projectName : ' talawa-api' , // repo name
16
+ organizationName : " PalisadoesFoundation" , // GitHub org
17
+ projectName : " talawa-api" , // repo name
18
18
19
- onBrokenLinks : ' throw' ,
20
- onBrokenMarkdownLinks : ' warn' ,
19
+ onBrokenLinks : " throw" ,
20
+ onBrokenMarkdownLinks : " warn" ,
21
21
22
22
// Even if you don't use internationalization, you can use this field to set
23
23
// useful metadata like html lang. For example, if your site is Chinese, you
24
24
// may want to replace "en" with "zh-Hans".
25
25
i18n : {
26
- defaultLocale : 'en' ,
27
- locales : [ 'en' ] ,
26
+ defaultLocale : "en" ,
27
+ locales : [ "en" ] ,
28
28
} ,
29
29
30
30
presets : [
31
31
[
32
- 'classic' ,
32
+ "classic" ,
33
+ /** @type {import('@docusaurus/preset-classic').Options } */
33
34
{
34
35
docs : {
35
- sidebarPath : './sidebars.ts' ,
36
- // Please change this to your repo.
37
- // Remove this to remove the "edit this page" links.
38
- editUrl : 'https://github.com/PalisadoesFoundation/talawa-api/blob/main/docs/' , } ,
36
+ sidebarPath : require . resolve ( "./sidebars.js" ) ,
37
+ editUrl : ( { docPath } ) => {
38
+ return `https://github.com/PalisadoesFoundation/talawa-api/edit/develop/docs/docs/${ docPath } ` ;
39
+ } ,
40
+ } ,
41
+ blog : {
42
+ showReadingTime : true ,
43
+ editUrl :
44
+ "https://github.com/PalisadoesFoundation/talawa-api/tree/develop/docs/docs" ,
45
+ } ,
39
46
theme : {
40
- customCss : './src/css/custom.css' ,
47
+ customCss : [
48
+ require . resolve ( "./src/css/custom.css" ) ,
49
+ require . resolve ( "./src/css/index.css" ) ,
50
+ ] ,
41
51
} ,
42
- } satisfies Preset . Options ,
52
+ } ,
43
53
] ,
44
54
] ,
45
55
46
56
themeConfig : {
47
57
// Replace with your project's social card
48
- image : ' img/docusaurus-social-card.jpg' ,
58
+ image : " img/docusaurus-social-card.jpg" ,
49
59
navbar : {
50
- title : ' Talawa-docs' ,
60
+ title : " Talawa API" ,
51
61
logo : {
52
- alt : ' My Site Logo' ,
53
- src : ' img/logos/logo.png' ,
62
+ alt : " My Site Logo" ,
63
+ src : " img/logos/logo.png" ,
54
64
} ,
55
65
items : [
56
66
{
57
- type : ' docSidebar' ,
58
- sidebarId : ' tutorialSidebar' ,
59
- position : ' left' ,
60
- label : 'Tutorial' ,
67
+ type : " docSidebar" ,
68
+ sidebarId : " tutorialSidebar" ,
69
+ position : " left" ,
70
+ label : "Docs" ,
61
71
} ,
62
72
{
63
73
label : "Mobile Guide" ,
64
74
position : "left" ,
65
- href : "https://docs-mobile.talawa.io/" ,
66
- target : "_blank " ,
75
+ href : "https://docs-mobile.talawa.io/docs " ,
76
+ target : "_self " ,
67
77
} ,
68
78
{
69
79
label : "Admin Guide" ,
70
80
position : "left" ,
71
- href : "https://docs-admin.talawa.io/" ,
72
- target : "_blank " ,
81
+ href : "https://docs-admin.talawa.io/docs " ,
82
+ target : "_self " ,
73
83
} ,
74
84
{
75
85
label : "API Guide" ,
76
86
position : "left" ,
77
- href : "https:// docs-api.talawa.io/ " ,
87
+ href : "/ docs" ,
78
88
target : "_self" ,
79
89
} ,
80
90
{
@@ -97,19 +107,19 @@ const config: Config = {
97
107
] ,
98
108
} ,
99
109
footer : {
100
- style : ' dark' ,
110
+ style : " dark" ,
101
111
links : [
102
112
{
103
- title : ' Docs' ,
113
+ title : " Docs" ,
104
114
items : [
105
115
{
106
- label : 'Tutorial' ,
107
- to : ' /docs/intro' ,
116
+ label : "Docs" ,
117
+ to : " /docs" ,
108
118
} ,
109
119
] ,
110
120
} ,
111
121
{
112
- title : ' Community' ,
122
+ title : " Community" ,
113
123
items : [
114
124
{
115
125
label : "Slack" ,
@@ -145,7 +155,7 @@ const config: Config = {
145
155
label : " Instagram" ,
146
156
to : "https://www.instagram.com/palisadoes/?hl=en" ,
147
157
className : "footer__icon footer__instagram" ,
148
- }
158
+ } ,
149
159
] ,
150
160
} ,
151
161
{
@@ -156,8 +166,8 @@ const config: Config = {
156
166
to : "https://github.com/PalisadoesFoundation" ,
157
167
className : "footer__icon footer__github" ,
158
168
} ,
159
- ]
160
- }
169
+ ] ,
170
+ } ,
161
171
] ,
162
172
copyright : `Copyright © ${ new Date ( ) . getFullYear ( ) } My Project, Inc. Built with Docusaurus.` ,
163
173
} ,
0 commit comments