Skip to content

Commit 381dcfe

Browse files
committed
doc: start documentation with mkdocs
1 parent 30a7af3 commit 381dcfe

30 files changed

+361
-27
lines changed

.eslintignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,6 @@ vscode.d.ts
77
vscode.proposed.d.ts
88

99
.mypy_cache/
10-
.pytest_cache/
10+
.pytest_cache/
11+
12+
site/

.vscode/launch.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,10 @@
3434
"request": "launch",
3535
"module": "robotcode.cli",
3636
"justMyCode": false,
37+
"cwd": "${workspaceFolder}/tests/robotcode/language_server/robotframework/parts/data",
3738
"args": [
38-
"run",
39-
"--help"
39+
"--dry",
40+
"run"
4041
]
4142
},
4243
{

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Autocompletion for:
5858
- Keywords with parameters
5959
- Namespaces
6060

61-
![Autocomplete Libraries and Keywords](./doc/images/autocomplete1.gif)
61+
![Autocomplete Libraries and Keywords](./docs/images/autocomplete1.gif)
6262

6363
Autocompletion supports all supported variables types
6464
- local variables
@@ -68,7 +68,7 @@ Autocompletion supports all supported variables types
6868
- command line variables
6969
- builtin variables
7070

71-
![Autocomplete Variables](./doc/images/autocomplete2.gif)
71+
![Autocomplete Variables](./docs/images/autocomplete2.gif)
7272

7373
### Code Navigation
7474

@@ -111,7 +111,7 @@ RobotCode can format your code with the internal RobotFramework robot.tidy tool
111111

112112
RobotCode supports running and debugging of RobotFramework testcases and tasks out of the box, directly from the definition of the test or suite.
113113

114-
![Running Tests](./doc/images/running_tests.gif)
114+
![Running Tests](./docs/images/running_tests.gif)
115115

116116
In the debug console you can see all log messages of the current run and navigate to the keyword the message was written by.
117117

@@ -165,7 +165,7 @@ See the difference:
165165

166166
| Before | After |
167167
| ---------------------------------------------------------------- | ---------------------------------------------------------- |
168-
| ![Without customization](./doc/images/without_customization.gif) | ![With customization](./doc/images/with_customization.gif) |
168+
| ![Without customization](./docs/images/without_customization.gif) | ![With customization](./docs/images/with_customization.gif) |
169169

170170

171171
As a template you can put the following code to your user settings of VSCode.

doc/.gitignore

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/CNAME

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
robotcode.io
14.5 KB
Binary file not shown.
15.2 KB
Binary file not shown.
15.4 KB
Binary file not shown.

docs/assets/fonts/OCRA.woff

14.6 KB
Binary file not shown.

docs/assets/fonts/OCRA2.woff

14.9 KB
Binary file not shown.

0 commit comments

Comments
 (0)