Skip to content

Commit

Permalink
Comment about code file name.
Browse files Browse the repository at this point in the history
  • Loading branch information
Clément committed May 28, 2024
1 parent 47288cc commit 81d3a96
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/about/user_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,14 +190,15 @@ The `{ width=80% }` attribute is optional.
- source code that is faulty, partial, or does not terminate can be included in markdown as inline code block
- we can automatically check these code snippets for syntactical correctness if these guidelines are followed

- code snippet can be included in markdown documents using pandoc-include filter:
- code snippet can be included in markdown documents using [pandoc-include](https://github.com/DCsunset/pandoc-include) filter:

<pre>
```
!include code/sample.cs
```
</pre>

Note that for [an unknown reason](https://github.com/DCsunset/pandoc-include/issues/45), no special characters (such as `_`) should be used in the filenames.
- Title each source code block included in markdown, this will create a URL for the code block and enables linking to it.
- code blocks are by default annotated as `csharp`
- syntax highlighting is applied automatically at build time based on the code block language
Expand Down

0 comments on commit 81d3a96

Please sign in to comment.