You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+2-16Lines changed: 2 additions & 16 deletions
Original file line number
Diff line number
Diff line change
@@ -139,26 +139,14 @@ To add a new project's documentation onto the project docs section of the websit
139
139
└── intro.md | Introduction/
140
140
_category_.json
141
141
```
142
-
3. The project's documentation files must follow [Docusaurus's](https://docusaurus.io/docs/create-doc) doc creation guidelines. <br/> This includes having proper front-matter and an appropriate `_category_.json` file for each folder.
143
-
144
-
Front Matter requirements:
145
-
1. All markdown files must have the following front-matter: (`#` is an integer)
142
+
3. The project's documentation files must follow [Docusaurus's](https://docusaurus.io/docs/create-doc) doc creation guidelines. <br/> The `_category_.json` file is autogenerated at website build time. The order in which the projects are displayed on the website is determined by the order in which the projects are listed in the `repos.json` file (top to bottom order).
143
+
4. Front Matter requirements: All markdown files must have the following front-matter: (`#` is an integer). This will affect the order in which the doc pages are displayed on the website (top to bottom order).
146
144
``` text
147
145
---
148
146
sidebar_position: #
149
147
---
150
148
```
151
149
152
-
2. Each folder and subfolder must contain a `_category_.json` file. Each `.json` file should be contain the following content:
153
-
``` json
154
-
{
155
-
"label": "My Project",
156
-
"position": #,
157
-
"link": {
158
-
"type": "generated-index"
159
-
}
160
-
}
161
-
```
162
150
Here the label should be your own. The label indicates the labeled name of the folder or subfolder to be shown. IE project name (`My Project`), subsection name (`Excersices`), etc. <br/>
163
151
The position value should also be customized to an `integer` representing the position of your folder or subfolder relative to other subfolders.
164
152
@@ -174,8 +162,6 @@ react-mui-resume
174
162
│ └── Intro.md
175
163
```
176
164
177
-
178
-
179
165
### In order to add your project:
180
166
1. Create a new branch from the **main** branch
181
167
2. Name the branch with the following convention: `feat: Add new project docs: PROJECTNAME`with `PROJECTNAME` being the name of your project.
0 commit comments