Skip to content
This repository has been archived by the owner on Apr 25, 2023. It is now read-only.

Commit

Permalink
last 1.5 update commit
Browse files Browse the repository at this point in the history
  • Loading branch information
@CodeDoctorDE
CodeDoctorDE committed May 10, 2021
1 parent d5defc3 commit a4303f2
Show file tree
Hide file tree
Showing 20 changed files with 1,013 additions and 2 deletions.
14 changes: 14 additions & 0 deletions app/android/fastlane/metadata/android/en-US/changelogs/12.txt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
> No breaking changes
* Add certificates
* Add statistics page
* Add reset button on all part items
* Remove coming soon in settings
* Fix responsive scroll views

API

> No breaking changes

* Add new quiz type: Multiple choice
* Add points to all part items
* Add `allow-reset` property to control if a user can reset the current part item
5 changes: 3 additions & 2 deletions docs/src/pages/versions.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,9 @@ currently being supported with security updates.
| Version | Supported | |
| ------- | --------- | ------------------------------------------------: |
| Preview | 🚧 | [Documentation](https://docs.dev-doctor.cf/next/) |
| 1.4.x | ✔️ | [Documentation](https://docs.dev-doctor.cf) |
| 1.3.x | ❌ | [Documentation](https://docs.dev-doctor.cf) |
| 1.5.x | ✔️ | [Documentation](https://docs.dev-doctor.cf) |
| 1.4.x | ❌ | [Documentation](https://docs.dev-doctor.cf/1.4/) |
| 1.3.x | ❌ | [Documentation](https://docs.dev-doctor.cf/1.4/) |
| 1.2.x | ❌ | [Documentation](https://docs.dev-doctor.cf/1.2/) |
| 1.1.x | ❌ | [Documentation](https://docs.dev-doctor.cf/1.2/) |
| 1.0.x | ❌ | [Documentation](https://docs.dev-doctor.cf/1.2/) |
Expand Down
56 changes: 56 additions & 0 deletions docs/versioned_docs/version-1.5/api.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
title: Main
id: api
---
## Example

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

<Tabs defaultValue="json" groupId="type" values={[
{ label: 'JSON', value: 'json', },
{ label: 'YAML', value: 'yaml', },
]}>
<TabItem value="json">

```json title="config.json"
{
"name": "Dev-Doctor",
"description": "The sample backend of dev-doctor",
"icon": null,
"courses": [
"example",
"example2"
]
}
```

</TabItem>
<TabItem value="yaml">

```yaml title="config.yml"
# The name of the current backend
name: 'Dev-Doctor'
# The description of the current backend
description: /
The sample backend of dev-doctor
# The icon of the backend. Supported values are [png, jpg, svg, null]
icon: null
# All courses of the current backend
courses:
- example
- example2
```
</TabItem>
</Tabs>
## Options
| Name | Type | Required | Description |
| :---------- | :----------------------------: | :------: | ----------------------------------------------------------------------------------------------------------------------------------------------: |
| name | String | true | The name of the current backend. It will show up in the backend store as title or in the servers settings. |
| description | String | false | The description of the current backend. It will show up in the backend store after the title. |
| icon | String (png, jpg, svg) or null | false | The icon will show up in the backend store in the list left to the title, on the details page of the backend store and in the servers settings. |
| courses | Array<String\> | true | The folder names of the courses. With this option the app will iterate above the courses |
| support_url | String | false | The current url where you can get help |
45 changes: 45 additions & 0 deletions docs/versioned_docs/version-1.5/api/author.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
title: Author
---
## Example

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

<Tabs defaultValue="json" groupId="type" values={[
{ label: 'JSON', value: 'json', },
{ label: 'YAML', value: 'yaml', },
]}>
<TabItem value="json">

```json title="config.json"
{
"name": "CodeDoctorDE" ,
"url": "https://github.com/CodeDoctorDE",
"avatar": "https://avatars1.githubusercontent.com/u/20452814?v=4",
"avatar-type": "png"
}
```

</TabItem>
<TabItem value="yaml">

```yaml title="config.yml"
"author":
"name": "CodeDoctorDE"
"url": "https://github.com/CodeDoctorDE"
"avatar": "https://avatars1.githubusercontent.com/u/20452814?v=4"
"avatar-type": "png"
```
</TabItem>
</Tabs>
## Options
| Name | Type | Required | Description |
| :---------- | :--------------------: | :------: | -----------------------------------------------------------------------: |
| name | String | true | The display name of the author. It will be displayed right to the avatar |
| url | String | false | The url which will be opened if the user clicks on the author |
| avatar | String | false | The url to the avatar image |
| avatar-type | String (png, jpg, svg) | false | The type of the current avatar |
128 changes: 128 additions & 0 deletions docs/versioned_docs/version-1.5/api/course.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
---
title: Course
---

## Example

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

<Tabs defaultValue="json" groupId="type" values={[
{ label: 'JSON', value: 'json', },
{ label: 'YAML', value: 'yaml', },
]}>
<TabItem value="json">

````json title="<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"
]
}
````

</TabItem>
<TabItem value="yaml">

````yaml title="<course>/config.yml"
# The icon of the backend. Supported values are [png, jpg, svg, null]
icon: png

# The name of the course. You can see it in the title or in the list
name: Example course

# The author. It will appear on the front page and on the courses list
author:
name: CodeDoctorDE
url: https://github.com/CodeDoctorDE
avatar: https://avatars1.githubusercontent.com/u/20452814?v=4

# The description of the course which can be seen in the list of the courses and the intro page.
description: >
This course is only an example which
shows how this config works
# The body is posting on the home page of the course page. Source: https://remarkjs.github.io/react-markdown/
body: |
Changes are automatically rendered as you type.
* Implements [GitHub Flavored Markdown](https://github.github.com/gfm/)
* Renders actual, "native" React DOM elements
* Allows you to escape or skip HTML (try toggling the checkboxes above)
* If you escape or skip the HTML, no `dangerouslySetInnerHTML` is used! Yay!
## Table of Contents
## HTML block below
<blockquote>
This blockquote will change based on the HTML settings above.
</blockquote>
## How about some code?
```js
var React = require('react');
var Markdown = require('react-markdown');
React.render(
<Markdown source="# Your markdown here" />,
document.getElementById('content')
);
```
Pretty neat, eh?
## Tables?
| Feature | Support |
| :-------: | ------- |
| tables | ✔ |
| alignment | ✔ |
| wewt | ✔ |
## More info?
Read usage information and more on [GitHub](https://github.com/remarkjs/react-markdown)
---------------
A component by [Espen Hovlandsdal](https://espen.codes/)
# The current category of the course. You can see the categories in the list
category: []

# The language of the course. You can see a flag as a badge of the course.
lang: en

# Controls if the course is shown in the list
private: true

# The course. See the preview to understand all config entries
parts:
- part-1
- part-2

````

</TabItem>
</Tabs>

## Options

| Name | Type | Required | Description |
| :---------- | :----------------------------: | :------: | ------------------------------------------------------------------------------------------------: |
| name | String | true | The name of the course. It will shown in the courses list and in the course details. |
| description | String | false | The description of the course which can be seen in the list of the courses and the intro page. |
| body | String (Markdown) | true | This will display on the course details page |
| icon | String (png, jpg, svg) or null | false | The icon will show up in the course list left to the title and on the details page of the course. |
| lang | String (Language tag) | false | The language of the current course |
| author | [Author](author.md) | false | The author. It will appear on the front page and on the courses list |
| category | Array<String\> | false | The current category of the course. You can see the categories in the list |
| private | Boolean | false | Controls if the course is shown in the list |
| parts | Array<String\> | true | The course contents. This are the folder names of the parts |
| support_url | String | false | The current url where you can get help. This will override the main support url |
18 changes: 18 additions & 0 deletions docs/versioned_docs/version-1.5/api/item/overview.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: Item
sidebar_label: Overview
---

## Sub classes

- [text](text)
- [video](video)
- [quiz](quiz)

## Options

| Name | Type | Required | Description |
| :---------- | :-------------------------------------------------: | :------: | ---------------------------------------------------------------------------------------------: |
| name | String | true | The name of the current part item. It will show up in the tab as label and in the details card |
| description | String | false | The description of the current part item. It will show up in the details card under the name |
| type | String ([text](text), [video](video), [quiz](quiz)) | true | The current sub class. |
Loading

0 comments on commit a4303f2

Please sign in to comment.