Add information how to compile individually specified examples only. #98
Conversation
|
@per1234 Would be very nice if this could be merged the additional information that was added helped resolve my issue, when trying to build only specific examples from the folder. |
|
Ping @per1234 😁 |
| @@ -163,6 +163,14 @@ Keys: | |||
|
|
|||
| **Default**: `"- examples"` | |||
|
|
|||
| If you want to specify individual sketches to be compiled, you can do so by passing a multi-line string (a so called [literal block scalar](https://www.yaml.info/learn/quote.html#literal)), i.e. | |||
| ``` | |||
There was a problem hiding this comment.
| ``` | |
| ```yml |
This will add the syntax highlighting that should be even more helpful. And it aligns with the highlighting of the other code snippets in this doc.
| @@ -163,6 +163,14 @@ Keys: | |||
|
|
|||
| **Default**: `"- examples"` | |||
|
|
|||
| If you want to specify individual sketches to be compiled, you can do so by passing a multi-line string (a so called [literal block scalar](https://www.yaml.info/learn/quote.html#literal)), i.e. | |||
There was a problem hiding this comment.
I think this information would be better moved to a much needed general explanation of the usage of the action inputs that accept YAML documents. Otherwise the same information would need to be duplicated for the platforms, libraries, and cli-flags inputs as well (#73).
The documentation for each of the individual inputs could then link to that single explanation.
| ``` | ||
| sketch-paths: | | ||
| - examples/Example-01 | ||
| - examples/Example-03 | ||
| - examples/Example-03 | ||
| ``` |
There was a problem hiding this comment.
| ``` | |
| sketch-paths: | | |
| - examples/Example-01 | |
| - examples/Example-03 | |
| - examples/Example-03 | |
| ``` | |
| <details> | |
| <summary><b>Click for an example</b></summary> | |
| <p> | |
| ``` | |
| sketch-paths: | | |
| - examples/Example-01 | |
| - examples/Example-03 | |
| - examples/Example-03 | |
| ``` | |
| </p> | |
| </details> |
This markup will put the example snippet in a collapsible section that is expanded by the reader on demand with a click:
Click for an example
sketch-paths: |
- examples/Example-01
- examples/Example-03
- examples/Example-03The reason I propose this approach is because I think it would be good to add similar examples to the other complex inputs, but such a significant amount of added content can harm the browsability of the readme for those who are looking for a general overview of the action's API.
| sketch-paths: | | ||
| - examples/Example-01 | ||
| - examples/Example-03 | ||
| - examples/Example-03 |
There was a problem hiding this comment.
| - examples/Example-03 | |
| - examples/Example-05 |
The examples/Example-03 path was duplicated.
No description provided.