Skip to content

Commit

Permalink
add to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ShaunSHamilton committed Feb 12, 2024
1 parent e24a637 commit b473a95
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 12 deletions.
8 changes: 6 additions & 2 deletions docs/src/plugin-system.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,11 @@ The `title` and `description` fields are expected to be either plain strings, or

### `getLesson`

```ts
```admonish attention
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>.
```

```typescript
(projectDashedName: string, lessonNumber: number) =>
Promise<{
description: string;
Expand All @@ -78,7 +82,7 @@ The `seed[].filePath` field is the relative path to the file from the workspace

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

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

## Example

Expand Down
2 changes: 1 addition & 1 deletion docs/src/project-syntax.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Project Syntax

This is the Markdown syntax used to create projects in the curriculum.
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).

## Markers

Expand Down
1 change: 0 additions & 1 deletion docs/src/roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,3 @@ For the most part, this roadmap outlines todos for `freecodecamp-os`. If this ro

- [ ] Loader to show progress of "Reset Step"
- [ ] Crowdin translation integration
- Possibly, this will include UI to select available languages
20 changes: 12 additions & 8 deletions docs/theme/css/general.css
Original file line number Diff line number Diff line change
Expand Up @@ -100,15 +100,15 @@ h6:target::before {
.page {
outline: 0;
padding: 0 var(--page-padding);
margin-top: calc(
0px - var(--menu-bar-height)
); /* Compensate for the #menu-bar-hover-placeholder */
margin-top: calc(0px - var(--menu-bar-height));
/* Compensate for the #menu-bar-hover-placeholder */
}
.page-wrapper {
box-sizing: border-box;
}
.js:not(.sidebar-resizing) .page-wrapper {
transition: margin-left 0.3s ease, transform 0.3s ease; /* Animation: slide away */
transition: margin-left 0.3s ease, transform 0.3s ease;
/* Animation: slide away */
}

.content {
Expand Down Expand Up @@ -213,10 +213,10 @@ kbd {
visibility: hidden;
color: #fff;
background-color: #333;
transform: translateX(
-50%
); /* Center by moving tooltip 50% of its width left */
left: -8px; /* Half of the width of the icon */
transform: translateX(-50%);
/* Center by moving tooltip 50% of its width left */
left: -8px;
/* Half of the width of the icon */
top: -35px;
font-size: 0.8em;
text-align: center;
Expand All @@ -238,3 +238,7 @@ kbd {
.result-no-output {
font-style: italic;
}

dfn[title] {
text-decoration: underline dotted;
}

0 comments on commit b473a95

Please sign in to comment.