An open learning platform for STEM.
Authors use Markdown to write articles on KnewHub. In addition to regular Markdown syntax, the following custom syntax is supported:
- Code blocks from separate code files in the repository where the Markdown file lives
- Syntax:
[codefile <relative_path>]
- Example:
[codefile ./code-files/code-example.c]
- Syntax:
- Code blocks from GitHub gists
- Syntax:
[codegist <gist_url>]
- Example:
[codegist https://gist.github.com/jp524/2d00cbf0a9976db406e4369b31e25460]
- Syntax:
- Collapsing elements (HTML details and summary tags)
- Syntax:
[details Hint]content[/details]
- Example:
[details Click Here to Display Content]Content[/details]
- Syntax:
- Viewing 3D files using Autodesk viewer
- Syntax:
[3d-viewer <relative_path>]
- Example:
[3d-viewer ./some-model.stp]
- Syntax:
Note that relative_path
cannot use underscores (_). Only alphanumeric characters and hyphens (-) are allowed.