Skip to content

Commit 060784b

Browse files
authored
feat: support dark mode and revamp docs visuals (#91)
* feat: revamp docs visuals * ci: use github runners instead of custom runners * feat: support dark mode and update tailwind * fix: fix header theme on landing page and minor styling issues * ci: fix storybook build * fix: use source inline instead of safelist * fix: fix preflight import * fix: fix table of contents styling * fix: fix font size in code blocks * fix: fix code blocks styling * fix: new theme switcher icon, auto hide header, minor code block fixes * chore: fix linting issues
1 parent 8502bda commit 060784b

File tree

71 files changed

+2248
-524
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

71 files changed

+2248
-524
lines changed

.github/workflows/checks.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ concurrency:
1515

1616
jobs:
1717
build:
18-
runs-on: self-hosted-arc
18+
runs-on: ubuntu-latest
1919

2020
strategy:
2121
matrix:
@@ -33,7 +33,7 @@ jobs:
3333
- run: npm test
3434

3535
deploy-static:
36-
runs-on: self-hosted-arc
36+
runs-on: ubuntu-latest
3737
environment: CI
3838

3939
strategy:

.github/workflows/deploy.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ jobs:
1717
# Build job
1818
build:
1919
environment: CI
20-
runs-on: self-hosted-arc
20+
runs-on: ubuntu-latest
2121
steps:
2222
- uses: actions/checkout@v4
2323
- uses: actions/setup-node@v4

.storybook/main.ts

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,7 @@ const config: StorybookConfig = {
4747
options: {
4848
postcssOptions: {
4949
ident: "postcss",
50-
plugins: [
51-
require("postcss-import"),
52-
require("tailwindcss"),
53-
require("autoprefixer"),
54-
],
50+
plugins: [require("@tailwindcss/postcss")],
5551
},
5652
},
5753
};

docs/command-line/index.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,6 +192,7 @@ testplane --repl --grep 'my test name' --browser chrome
192192
- `--keep-browser-on-fail` - the same as the `--keep-browser` option, but the browser will only remain open if the tests fail.
193193
194194
Example of console output with connection information to the browser:
195+
195196
```
196197
[15:44:38 +0700] Testplane run has finished, but the browser won't be closed, because you passed the --keep-browser argument.
197198
[15:44:38 +0700] You may attach to this browser using the following capabilities:

docs/config/browsers.mdx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,11 @@ In this example, the value `10` will be used for the `sessionsPerBrowser` option
4949
<tr>
5050
<td>[`gridUrl`](#grid_url)</td>
5151
<td>`string`</td>
52-
<td>`"http://localhost:4444/wd/hub"`</td>
52+
<td>
53+
`"http://localhost`
54+
<br />
55+
`:4444/wd/hub"`
56+
</td>
5357
<td>Selenium grid URL.</td>
5458
</tr>
5559
<tr>

docs/guides/local-browsers.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ Supported browser versions per OS:
8181
| Edge | \* | \* | \* | \* | \* |
8282
| Safari | - | \* | - | - | - |
8383

84-
- - Browser auto download is not supported, but if the browser is installed by the user himself, installed version will be used by Testplane.
84+
> `*` — browser auto download is not supported, but if the browser is installed by the user himself, installed version will be used by Testplane.
8585
8686
For virtual environments, you would need to run headless. "--no-sandbox" CLI arg for "chrome" browser could also be necessary:
8787

docs/reference/testplane-standalone-api.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import { launchBrowser } from "testplane/unstable";
1818
// Launch a new browser with the given settings
1919
const browser = await launchBrowser({
2020
desiredCapabilities: {
21-
browserName: 'chrome',
21+
browserName: "chrome",
2222
},
2323
headless: false,
2424
});

docusaurus.config.ts

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ const config: Config = {
4545
sidebarPath: "./sidebars.ts",
4646
editUrl: "https://github.com/gemini-testing/testplane-docs/tree/master/",
4747
lastVersion: "current",
48+
breadcrumbs: false,
4849
versions: {
4950
current: {
5051
label: "v8",
@@ -65,11 +66,20 @@ const config: Config = {
6566

6667
themeConfig: {
6768
colorMode: {
68-
disableSwitch: true,
69+
disableSwitch: false,
6970
},
7071
image: "img/docusaurus-social-card.jpg",
7172
navbar: {
73+
hideOnScroll: true,
7274
title: "testplane",
75+
logo: {
76+
alt: "Testplane Logo",
77+
src: "img/logo.svg",
78+
srcDark: "img/logo-dark.svg",
79+
target: "_self",
80+
width: 28,
81+
height: 28,
82+
},
7383
items: [
7484
{
7585
type: "docSidebar",
@@ -167,7 +177,6 @@ const config: Config = {
167177
],
168178
},
169179
],
170-
copyright: `MIT License © ${new Date().getFullYear()}`,
171180
},
172181
prism: {
173182
theme: prismThemes.github,

i18n/ru/docusaurus-plugin-content-docs/current/command-line/index.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -193,6 +193,7 @@ testplane --repl --grep 'my test name' --browser chrome
193193
- `--keep-browser-on-fail` - то же, что и опция `--keep-browser`, только браузер останется только в том случае, если тесты завершатся неуспешно
194194
195195
Пример вывода в консоли c информацией для подключения к браузеру
196+
196197
```
197198
[15:44:38 +0700] Testplane run has finished, but the browser won't be closed, because you passed the --keep-browser argument.
198199
[15:44:38 +0700] You may attach to this browser using the following capabilities:

i18n/ru/docusaurus-plugin-content-docs/current/config/browsers.mdx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,11 @@ import AssertViewOptions from "@site/docs/_partials/specs/assert-view-options.md
4949
<tr>
5050
<td>[`gridUrl`](#grid_url)</td>
5151
<td>`string`</td>
52-
<td>`"http://localhost:4444/wd/hub"`</td>
52+
<td>
53+
`"http://localhost`
54+
<br />
55+
`:4444/wd/hub"`
56+
</td>
5357
<td>URL грида Selenium.</td>
5458
</tr>
5559
<tr>

0 commit comments

Comments
 (0)