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
You are building a static website that documents C/C++ language features and standard library facilities for C/C++ developers.
4
+
5
+
## Project Structure
6
+
7
+
- The `src/content/docs` subdirectory is where the documentation pages should go.
8
+
- Documentations for C language features go into `src/content/docs/c/language`.
9
+
- Documentations for C standard library facilities go into `src/content/docs/c/library`.
10
+
- Documentations for C++ language feature go into `src/content/docs/cpp/language`.
11
+
- Documentations for C++ standard library facilities go into `src/content/docs/cpp/library`.
12
+
- The `src/components` contains reusable UI components for the documentation pages.
13
+
14
+
## Development Guidelines
15
+
16
+
- Each paragraph should generally be a single line of source code.
17
+
- Avoid writing source code that does not contribute to actual content as much as possible, extract layout code into reusable components when possible.
18
+
- Avoid inline Markdown tables with more than 3 columns.
19
+
- When designing content layout, consider layout on mobile devices as a first-class usage.
20
+
21
+
## Code Style
22
+
23
+
- Use double quotes in MDX, JavaScript, TypeScript code.
24
+
- Always prefer TypeScript over JavaScript when possible.
25
+
- Use explicit semicolons in JavaScript and TypeScript code.
26
+
27
+
## Development Tools
28
+
29
+
- Run `npm run format` to format the code once you made any changes.
0 commit comments