Skip to main content
Version: 1.6

Course

Example

<course>/config.json
{
"icon": "png",
"name": "Example course",
"author": {
"name": "CodeDoctorDE",
"url": "https://github.com/CodeDoctorDE",
"avatar": "https://avatars1.githubusercontent.com/u/20452814?v=4"
},
"description": "This course is only an example which shows how this config works\n",
"body": "Changes are automatically rendered as you type.\n* Implements [GitHub Flavored Markdown](https://github.github.com/gfm/)\n* Renders actual, \"native\" React DOM elements\n* Allows you to escape or skip HTML (try toggling the checkboxes above)\n* If you escape or skip the HTML, no `dangerouslySetInnerHTML` is used! Yay!\n## Table of Contents\n## HTML block below\n<blockquote>\n This blockquote will change based on the HTML settings above.\n</blockquote>\n## How about some code?\n```js\nvar React = require('react');\nvar Markdown = require('react-markdown');\nReact.render(\n <Markdown source=\"# Your markdown here\" />,\n document.getElementById('content')\n);\n```\n\nPretty neat, eh?\n\n## Tables?\n\n| Feature | Support |\n| :-------: | ------- |\n| tables | ✔ |\n| alignment | ✔ |\n| wewt | ✔ |\n\n## More info?\n\nRead usage information and more on [GitHub](https://github.com/remarkjs/react-markdown)\n---------------\nA component by [Espen Hovlandsdal](https://espen.codes/)\n",
"category": [],
"lang": "en",
"private": true,
"parts": [
"part-1",
"part-2"
]
}

Options

NameTypeRequiredDescription
nameStringtrueThe name of the course. It will shown in the courses list and in the course details.
descriptionStringfalseThe description of the course which can be seen in the list of the courses and the intro page.
bodyString (Markdown)trueThis will display on the course details page
iconString (png, jpg, svg) or nullfalseThe icon will show up in the course list left to the title and on the details page of the course.
langString (Language tag)falseThe language of the current course
authorAuthorfalseThe author. It will appear on the front page and on the courses list
categoryArray<String>falseThe current category of the course. You can see the categories in the list
privateBooleanfalseControls if the course is shown in the list
partsArray<String>trueThe course contents. This are the folder names of the parts
support_urlStringfalseThe current url where you can get help. This will override the main support url