Skip to content

[EmioLabs] create your own lab: adds solution and include documentation#67

Open
HanaeRateau wants to merge 3 commits into
mainfrom
pr_newcommands
Open

[EmioLabs] create your own lab: adds solution and include documentation#67
HanaeRateau wants to merge 3 commits into
mainfrom
pr_newcommands

Conversation

@HanaeRateau
Copy link
Copy Markdown
Collaborator

This PR:

  • adds the #include command and the solution documentation
  • reorders the extended syntax command alphabetically
image

@HanaeRateau HanaeRateau changed the title Adds solution and include documentation [EmioLabs] Adds solution and include documentation May 29, 2026
@HanaeRateau HanaeRateau changed the title [EmioLabs] Adds solution and include documentation [EmioLabs] create your own lab: adds solution and include documentation May 29, 2026
::: highlight
MY_CONTENT
:::info
The labs that come with Emio Labs will look for the solution files in the solutions directory `path/to/home/emio-labs/VERSION/assets/solutions/LAB_NAME/`. Make sure to put the solution files in this directory.
Copy link
Copy Markdown
Contributor

@EulalieCoevoet EulalieCoevoet May 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My understanding of this sentence is that it only concerns the labs distributed with Emio Labs

#### Exercise Block
##### Inline Solution
The content of the solution is given by the markdown file `MY_SOLUTION.md` and the solution block with the id `MY_SOLUTION_ID` in this markdown file. For example, if the solution file contains
`#solution(file="assets/solutions/<LAB_NAME>/MY_SOLUTION.md", id="MY_SOLUTION_ID")`, it will display the content of the solution block with the id `MY_SOLUTION_ID` in the file `MY_SOLUTION.md`.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we should start by explaining the solution block.

@EulalieCoevoet EulalieCoevoet added the documentation Improvements or additions to documentation label May 30, 2026
@EulalieCoevoet
Copy link
Copy Markdown
Contributor

What do you think about adding an image? Like :

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants