Skip to content

Commit b1008a8

Browse files
Snooz82cz-lucas
andauthored
Added Example Exam
* Installed quizdown and created page * First working version of the quiz * The questions can now be defined inside the Quiz-tag * Updated yarn lockfile * Made syntaxhighlighting working (not for robotframework) * Added syntaxhighlighting for robotframework (requires a modified version of quizdown) * Using own version of quizdown with support for own hljs parsers * Change darkmode colors (#6) * Changed quizdown lib * Added darkmode to quiz * Added darkmode for code inside the quiz * Fixed that wrong theme is shown on initial pageload * Global import and quiz on all pages (#7) * Added global import for the quiz-component * Added quiz to normal docs page (2.3 executing) * Result storage (#10) * Added zustand as a central store and storing all quizzes in it. Now the property name is required that needs to be unique on each page. * Updated quizdown-extended to 0.6.5 * Added storage for quiz results * Saving quizresults in localstorage * Added quizResultpage-sidebar * Made first version of the quiz result page * Fixed quiz prebuild script * Next version of the resultsPage * Added link to view the results to the quiz component * Fixed build error * Fixed resultpage * Delete node_modules directory * Update to quizdown extended 1.0.0 (#11) * Started adding quizdown-extended v1 * massive refactoring regarding quizdown-extended --------- Co-authored-by: cz-lucas <46531925+cz-lucas@users.noreply.github.com> * test page build * Add GitHub Actions workflow for Docusaurus deployment * test page build * example from pieter * example from pieter * bumpt to quizdown-extended 1.1.1 * bumpt to quizdown-extended 1.2.1 * slight changes * just another trigger * just another trigger * just another trigger * worked in feedback from PR in Chapters 0-3, 4 and 5 missing * updated dependencies * fixed #54, User Keywords now can also define argument types. * releasable example exam * added pdf to home page --------- Co-authored-by: cz-lucas <46531925+cz-lucas@users.noreply.github.com>
1 parent 3993b40 commit b1008a8

26 files changed

+12503
-17033
lines changed

.github/.workflows/pages.yml

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: Build & Deploy Docusaurus (GitHub Pages)
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
pages: write # required for actions/deploy-pages
11+
id-token: write # required for OIDC auth to Pages
12+
13+
concurrency:
14+
group: "pages"
15+
cancel-in-progress: true
16+
17+
jobs:
18+
build:
19+
name: Build site
20+
runs-on: ubuntu-latest
21+
defaults:
22+
run:
23+
working-directory: ./website
24+
steps:
25+
- name: Checkout
26+
uses: actions/checkout@v4
27+
with:
28+
fetch-depth: 0
29+
30+
- name: Use Node.js
31+
uses: actions/setup-node@v4
32+
with:
33+
node-version: 22
34+
cache: yarn
35+
cache-dependency-path: website/yarn.lock
36+
37+
- name: Install deps
38+
run: yarn install --frozen-lockfile
39+
40+
- name: Build
41+
run: yarn build
42+
43+
# Package the static output for Pages
44+
- name: Upload Pages artifact
45+
uses: actions/upload-pages-artifact@v3
46+
with:
47+
path: ./website/build
48+
49+
deploy:
50+
name: Deploy to GitHub Pages
51+
needs: build
52+
runs-on: ubuntu-latest
53+
environment:
54+
name: github-pages
55+
url: ${{ steps.deployment.outputs.page_url }}
56+
steps:
57+
- name: Deploy
58+
id: deployment
59+
uses: actions/deploy-pages@v4

.github/.workflows/test-deploy.yml

Lines changed: 0 additions & 29 deletions
This file was deleted.

.gitignore

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
.idea
22
folder
33
__pycache__
4-
results
4+
results
5+
6+
.vscode
7+
.devcontainer

website/docs/chapter-02/03_executing.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
# 2.3 Executing Robot
32

43
::::lo[Learning Objectives]
@@ -200,7 +199,3 @@ There are basically two kinds of logging information in Robot Framework.
200199

201200
Log messages can be written with different levels of severity (i.e. `INFO`, `DEBUG`, `TRACE`, `WARN` or `ERROR`).
202201
Which levels are written to the log can be controlled by the log level of an execution. Further information in later chapters.
203-
204-
205-
206-

website/docs/chapter-02/05_keyword_interface.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -362,7 +362,7 @@ Understand the concept of argument types and automatic type conversion.
362362

363363
::::
364364

365-
Library Keywords may define the expected types of their argument values.
365+
Keywords may define the expected types of their argument values.
366366
The Robot Framework specification is predominantly a string-based language, therefore most statically defined argument values are strings.
367367
However, the actual implementation of the keyword may expect a different type of argument, like an integer.
368368

website/docs/chapter-03/03_user_keyword.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ See also Chapter 2 [2.5.2 Keyword Arguments](chapter-02/05_keyword_interface.md#
161161

162162
Arguments are defined by `[Arguments]` followed by the argument names separated by multiple spaces in the syntax of scalar variables.
163163

164-
Unlike Library Keywords, User Keywords cannot define argument types like `string`, `number`, etc., as described in the [2.5.2.8 Argument Types](chapter-02/05_keyword_interface.md#2528-argument-types) section.
164+
Since Robot Framework 7.3 User Keywords can define argument types like `string`, `number`, etc., as described in the [2.5.2.8 Argument Types](chapter-02/05_keyword_interface.md#2528-argument-types) section.
165165

166166

167167
### 3.3.5.1 Defining Mandatory Arguments
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
import Quiz from '@site/src/components/Quiz/Quiz';
2+
3+
# Example Questions
4+
5+
This example exam should give you the oportunity to check you knowledge and to get an impression what kind of questions may be asked in the real examination for RFCP®.
6+
7+
<Quiz name="Example" src="Example.md"/>
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"label": "Example Exam"
3+
}

website/docusaurus.config.ts

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,11 @@ const config = {
1313
url: 'https://robotframework.org',
1414
baseUrl: '/robotframework-RFCP-syllabus/',
1515
onBrokenLinks: 'throw',
16-
onBrokenMarkdownLinks: 'warn',
16+
markdown: {
17+
hooks: {
18+
onBrokenMarkdownLinks: 'throw',
19+
},
20+
},
1721
favicon: 'img/rf_favicon.png',
1822
organizationName: 'robotframework', // Usually your GitHub org/user name.
1923
projectName: 'robotframework-RFCP-syllabus', // Usually your repo name.
@@ -31,7 +35,7 @@ const config = {
3135
routeBasePath: '/docs',
3236
sidebarPath: require.resolve('./sidebars.js'),
3337
// Please change this to your repo.
34-
editUrl: 'https://github.com/robotframework/robotframework-RFCP-syllabus/edit/docusaurus/website',
38+
// editUrl: 'https://github.com/robotframework/robotframework-RFCP-syllabus/edit/docusaurus/website',
3539
remarkPlugins: [remarkDirective, remarkTermDirective],
3640
},
3741
blog: false,
@@ -87,6 +91,11 @@ const config = {
8791
to: '/docs/chapter-05/overview',
8892
position: 'left',
8993
},
94+
{
95+
label: 'Example Exam',
96+
to: '/docs/example-exam',
97+
position: 'left',
98+
},
9099
{
91100
label: 'LOs',
92101
to: '/docs/learning_objectives',
@@ -162,7 +171,9 @@ const config = {
162171
additionalLanguages: ['robotframework', 'python'],
163172
},
164173
}),
165-
plugins: [require.resolve('docusaurus-lunr-search')],
174+
plugins: [
175+
require.resolve('docusaurus-lunr-search')
176+
],
166177
};
167178

168179
module.exports = config;

0 commit comments

Comments
 (0)