Skip to content

Commit b473a95

Browse files
add to docs
1 parent e24a637 commit b473a95

4 files changed

Lines changed: 19 additions & 12 deletions

File tree

docs/src/plugin-system.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,11 @@ The `title` and `description` fields are expected to be either plain strings, or
5353

5454
### `getLesson`
5555

56-
```ts
56+
```admonish attention
57+
This function can be called multiple times per lesson. Therefore, it is expected to be <dfn title="An operation that can be applied multiple times without changing the result after the initial application.">idempotent</dfn>.
58+
```
59+
60+
```typescript
5761
(projectDashedName: string, lessonNumber: number) =>
5862
Promise<{
5963
description: string;
@@ -78,7 +82,7 @@ The `seed[].filePath` field is the relative path to the file from the workspace
7882

7983
The `seed[]` field can also be a plain string, which is then treated as a `bash` command to be run in the workspace root.
8084

81-
An example of this can be seen in the default parser used: https://github.com/freeCodeCamp/freeCodeCampOS/blob/main/.freeCodeCamp/plugin/index.js
85+
An example of this can be seen in the default parser used: <https://github.com/freeCodeCamp/freeCodeCampOS/blob/main/.freeCodeCamp/plugin/index.js>
8286

8387
## Example
8488

docs/src/project-syntax.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Project Syntax
22

3-
This is the Markdown syntax used to create projects in the curriculum.
3+
This is the Markdown syntax used to create projects in the curriculum using the default parser. The parser can be configured using the [plugin-system](./plugin-system.md).
44

55
## Markers
66

docs/src/roadmap.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,3 @@ For the most part, this roadmap outlines todos for `freecodecamp-os`. If this ro
88

99
- [ ] Loader to show progress of "Reset Step"
1010
- [ ] Crowdin translation integration
11-
- Possibly, this will include UI to select available languages

docs/theme/css/general.css

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -100,15 +100,15 @@ h6:target::before {
100100
.page {
101101
outline: 0;
102102
padding: 0 var(--page-padding);
103-
margin-top: calc(
104-
0px - var(--menu-bar-height)
105-
); /* Compensate for the #menu-bar-hover-placeholder */
103+
margin-top: calc(0px - var(--menu-bar-height));
104+
/* Compensate for the #menu-bar-hover-placeholder */
106105
}
107106
.page-wrapper {
108107
box-sizing: border-box;
109108
}
110109
.js:not(.sidebar-resizing) .page-wrapper {
111-
transition: margin-left 0.3s ease, transform 0.3s ease; /* Animation: slide away */
110+
transition: margin-left 0.3s ease, transform 0.3s ease;
111+
/* Animation: slide away */
112112
}
113113

114114
.content {
@@ -213,10 +213,10 @@ kbd {
213213
visibility: hidden;
214214
color: #fff;
215215
background-color: #333;
216-
transform: translateX(
217-
-50%
218-
); /* Center by moving tooltip 50% of its width left */
219-
left: -8px; /* Half of the width of the icon */
216+
transform: translateX(-50%);
217+
/* Center by moving tooltip 50% of its width left */
218+
left: -8px;
219+
/* Half of the width of the icon */
220220
top: -35px;
221221
font-size: 0.8em;
222222
text-align: center;
@@ -238,3 +238,7 @@ kbd {
238238
.result-no-output {
239239
font-style: italic;
240240
}
241+
242+
dfn[title] {
243+
text-decoration: underline dotted;
244+
}

0 commit comments

Comments
 (0)