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
+18-15Lines changed: 18 additions & 15 deletions
Original file line number
Diff line number
Diff line change
@@ -95,6 +95,21 @@ Changes to `package-lock.json` and `yarn.lock` files should only be committed wh
95
95
- Updating an existing dependency: Running an update for a package will adjust these files to reflect the new versions.
96
96
- Removing a dependency: Uninstalling a package will update these files to remove the reference to the dependency.
97
97
98
+
### Content File Formats
99
+
100
+
**Use `.md` or `.mdx` file formats** MDX is a markdown format that allows embedded JSX components for more flexibility. Refer to the Docusaurus Docs page [MDX and React](https://docusaurus.io/docs/markdown-features/react) for information on MDX syntax and capabilities.
101
+
102
+
**Always link using explicit heading IDs** when adding or editing headings in a `.md` or `.mdx` file. This prevents broken links if heading text changes later. For example:
103
+
104
+
```markdown
105
+
### My Important Section{#my-important-section}
106
+
```
107
+
Then, you can link to this section using:
108
+
109
+
```markdown
110
+
[Link to my section](#my-important-section)
111
+
```
112
+
98
113
### Add or Edit Feature Cards
99
114
100
115
Feature Cards on the website homepage highlight the key features of the PEcAn Project.
@@ -177,28 +192,16 @@ tags: [gsoc, gsoc21]
177
192
---
178
193
```
179
194
195
+
196
+
<!-- These screenshots are large and don't appear to be in the right place, if necessary
180
197
## Screenshots
181
198
182
199
This section contains screenshots of website's homepage in light and dark theme.
183
200
184
201

185
202
186
203

187
-
188
-
## Editing a Documentation File
189
-
The PEcAn documentation is a crucial part of the project. We aim to make it comprehensive, accurate, and easy to navigate. When contributing to documentation, please keep the following in mind:
190
-
191
-
***Always use explicit heading IDs** when adding or editing headings in documentation file(`.mdx`). This prevents broken links if heading text changes later. For example:
192
-
193
-
```markdown
194
-
### My Important Section{#my-important-section}
195
-
```
196
-
Then, you can link to this section using:
197
-
198
-
```markdown
199
-
[Link to my section](#my-important-section)
200
-
```
201
-
***Use appropriate file formats**, primarily Markdown (`.md`) and MDX (`.mdx`). MDX allows embedding JSX components within documentation for more flexibility. Refer to [Docusaurus Docs](https://docusaurus.io/docs) for MDX syntax.
0 commit comments