Skip to content

Fix pipelines: [docs] Adjust Vale Doc Linter and Prettier configurations Issue #517

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion STYLE.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ If you use an en dash in one range, use en dashes in all ranges.
Do not mix words and en dashes (or hyphens, for that matter).

- Correct: "5 to 10 GB"
- Correct: "510 GB"
- Correct: "5-10 GB"
- Correct: "5-10 GB"
- Incorrect: "from 5-10 GB"

Expand Down
2 changes: 1 addition & 1 deletion docs/hacktoberfest/contribution-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ If you’ve ever wanted to contribute to open source, now is your chance! You ca

Anyone around the globe who desires to help drive the growth of open source and make positive contributions to an ever-growing community. All backgrounds and skill levels are encouraged to participate.

- Code Contributribution to Keploy Projects includes:
- Code Contribution to Keploy Projects includes:

- Bug fixes
- New features
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@
"postcss": "^8.4.4",
"postcss-import": "^14.0.2",
"postcss-preset-env": "^7.4.1",
"prettier": "^2.5.1",
"prettier": "^2.8.8",
"prettier-plugin-tailwindcss": "^0.1.4",
"rimraf": "^6.0.1",
"tailwindcss": "^3.0.1"
Expand Down
54 changes: 33 additions & 21 deletions src/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,19 @@

:root {
/* Hotfix: Changed primary color to black to resolve conflict with Docusaurus' default primary orange after disabling Tailwind preflight CSS. Added font size and line height adjustments to compensate for the removal of Tailwind preflight. */

/* --ifm-color-primary-lighter: #ffb575; */
font-size:18px;
font-size: 18px;
line-height: 1.6;
--ifm-color-primary: #000;

--ifm-color-primary-lighter: #FFF;
--ifm-color-primary-lighter: #fff;
--ifm-color-primary: #ff914d;
--ifm-color-primary-dark: #e67643;
--ifm-color-primary-darker: #c95919;
--ifm-color-primary-darkest: #be2c1b;
--ifm-color-primary-light: #ffd0a0;

--ifm-color-primary-lightest: #ffceb1;
--ifm-code-font-size: 95%;
--doc-sidebar-width: 275px !important;
Expand All @@ -36,11 +36,10 @@

html[data-theme="dark"] {
/* Hotfix: Changed 'ifm-color-primary-lighter' to white to resolve conflict with Docusaurus' default color after disabling Tailwind preflight CSS. */


/* --ifm-color-primary-lighter: #ffb575; */
--ifm-color-primary-lighter: #FFF;
--ifm-color-primary-lighter: #fff;

--ifm-color-primary: #ff914d;
--ifm-color-primary-dark: #e67643;
--ifm-color-primary-darker: #c95919;
Expand Down Expand Up @@ -111,7 +110,7 @@ html[data-theme="light"] {
}

/* Hotfix: Remove extra margin-bottom on community links subtext in the home page due to Tailwind preflight removal */
h3{
h3 {
margin-bottom: 0.1rem;
}
h1,
Expand All @@ -120,9 +119,21 @@ h3,
h4,
.menu__list,
.navbar {
font-family: "Aeonik", system-ui, -apple-system, BlinkMacSystemFont,
"Segoe UI", Roboto, "Helvetica Neue", Arial, "Noto Sans", sans-serif,
"Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji";
font-family:
"Aeonik",
system-ui,
-apple-system,
BlinkMacSystemFont,
"Segoe UI",
Roboto,
"Helvetica Neue",
Arial,
"Noto Sans",
sans-serif,
"Apple Color Emoji",
"Segoe UI Emoji",
"Segoe UI Symbol",
"Noto Color Emoji";
}

.menu__list {
Expand Down Expand Up @@ -334,7 +345,7 @@ footer svg {
}

/* Reset margin bottom on h3 (refer docs community section li item heading) after disabling tailwind preflight. */
h3{
h3 {
margin-bottom: 1px;
}

Expand Down Expand Up @@ -583,13 +594,14 @@ a[class="breadcrumbs__link"] {
}

/* Hotfix: Manually add Tailwind preflight styles to fix clipboard issues in Safari.
Using `preflight: true` caused style conflicts, so these styles are directly included here. */*,
Using `preflight: true` caused style conflicts, so these styles are directly included here. */
*,
::before,
::after {
box-sizing: border-box;
border-width: 0;
border-style: solid;
border-color: theme('borderColor.DEFAULT', currentColor);
border-color: theme("borderColor.DEFAULT", currentColor);
}

* {
Expand All @@ -602,7 +614,7 @@ html {
-webkit-text-size-adjust: 100%;
-moz-tab-size: 4;
tab-size: 4;
font-family: theme('fontFamily.sans', ui-sans-serif, system-ui, sans-serif);
font-family: theme("fontFamily.sans", ui-sans-serif, system-ui, sans-serif);
}

body {
Expand Down Expand Up @@ -656,9 +668,9 @@ html {
}

button,
[type='button'],
[type='reset'],
[type='submit'] {
[type="button"],
[type="reset"],
[type="submit"] {
-webkit-appearance: button;
background-color: transparent;
background-image: none;
Expand All @@ -685,12 +697,12 @@ menu {
}

:focus-visible {
outline: 2px solid theme('colors.blue.600', #2563eb);
outline: 2px solid theme("colors.blue.600", #2563eb);
outline-offset: 2px;
}

[type='number']::-webkit-inner-spin-button,
[type='number']::-webkit-outer-spin-button {
[type="number"]::-webkit-inner-spin-button,
[type="number"]::-webkit-outer-spin-button {
height: auto;
}

Expand Down
4 changes: 2 additions & 2 deletions src/pages/concepts/reference/glossary.js
Original file line number Diff line number Diff line change
Expand Up @@ -165,8 +165,8 @@ function Glossary() {
state[String.fromCharCode(65 + i)]
? "text-black-200 rounded-3xl bg-orange-200 font-bold shadow-md hover:text-orange-950 dark:text-orange-900"
: entries[String.fromCharCode(65 + i)] === undefined
? "bg-transparent text-gray-400" // Modified color class
: "bg-grey-200 rounded-3xl shadow-md"
? "bg-transparent text-gray-400" // Modified color class
: "bg-grey-200 rounded-3xl shadow-md"
} `}
key={i}
disabled={
Expand Down
2 changes: 1 addition & 1 deletion src/pages/styles.module.css
Original file line number Diff line number Diff line change
Expand Up @@ -159,4 +159,4 @@
.announcementInner {
margin: 0 auto;
max-width: 768px;
}
}
2 changes: 1 addition & 1 deletion src/theme/Heading/styles.module.css
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ See https://twitter.com/JoshWComeau/status/1332015868725891076
}

:global(.hash-link::before) {
content: '#';
content: "#";
}

:global(.hash-link:focus),
Expand Down
74 changes: 37 additions & 37 deletions static/css/code-block-buttons.css
Original file line number Diff line number Diff line change
@@ -1,39 +1,39 @@
/* "Copy" code block button */
pre {
position: relative;
}
pre .btnIcon {
position: absolute;
top: 4px;
z-index: 2;
cursor: pointer;
border: 1px solid transparent;
padding: 0;
color: #fff;
background-color: transparent;
height: 30px;
transition: all .25s ease-out;
}
pre .btnIcon:hover {
text-decoration: none;
}
.btnIcon__body {
align-items: center;
display: flex;
}
.btnIcon svg {
fill: currentColor;
margin-right: .4em;
}
.btnIcon__label {
font-size: 11px;
}
.btnClipboard {
right: 10px;
}
position: relative;
}

pre .btnIcon {
position: absolute;
top: 4px;
z-index: 2;
cursor: pointer;
border: 1px solid transparent;
padding: 0;
color: #fff;
background-color: transparent;
height: 30px;
transition: all 0.25s ease-out;
}

pre .btnIcon:hover {
text-decoration: none;
}

.btnIcon__body {
align-items: center;
display: flex;
}

.btnIcon svg {
fill: currentColor;
margin-right: 0.4em;
}

.btnIcon__label {
font-size: 11px;
}

.btnClipboard {
right: 10px;
}
2 changes: 1 addition & 1 deletion vale_styles/Google/AMPM.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
extends: existence
message: "Use 'AM' or 'PM' (preceded by a space)."
link: 'https://developers.google.com/style/word-list'
link: "https://developers.google.com/style/word-list"
level: error
nonword: true
tokens:
Expand Down
2 changes: 1 addition & 1 deletion vale_styles/Google/Acronyms.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
extends: conditional
message: "Spell out '%s', if it's unfamiliar to the audience."
link: 'https://developers.google.com/style/abbreviations'
link: "https://developers.google.com/style/abbreviations"
level: suggestion
ignorecase: false
# Ensures that the existence of 'first' implies the existence of 'second'.
Expand Down
2 changes: 1 addition & 1 deletion vale_styles/Google/Colons.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
extends: existence
message: "'%s' should be in lowercase."
link: 'https://developers.google.com/style/colons'
link: "https://developers.google.com/style/colons"
nonword: true
level: warning
scope: sentence
Expand Down
2 changes: 1 addition & 1 deletion vale_styles/Google/Contractions.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
extends: substitution
message: "Feel free to use '%s' instead of '%s'."
link: 'https://developers.google.com/style/contractions'
link: "https://developers.google.com/style/contractions"
level: suggestion
ignorecase: true
action:
Expand Down
2 changes: 1 addition & 1 deletion vale_styles/Google/DateFormat.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
extends: existence
message: "Use 'July 31, 2016' format, not '%s'."
link: 'https://developers.google.com/style/dates-times'
link: "https://developers.google.com/style/dates-times"
ignorecase: true
level: error
nonword: true
Expand Down
2 changes: 1 addition & 1 deletion vale_styles/Google/Ellipses.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
extends: existence
message: "In general, don't use an ellipsis."
link: 'https://developers.google.com/style/ellipses'
link: "https://developers.google.com/style/ellipses"
nonword: true
level: warning
action:
Expand Down
4 changes: 2 additions & 2 deletions vale_styles/Google/EmDash.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
extends: existence
message: "Don't put a space before or after a dash."
link: 'https://developers.google.com/style/dashes'
link: "https://developers.google.com/style/dashes"
nonword: true
level: error
action:
name: edit
params:
- remove
- ' '
- " "
tokens:
- '\s[—–]\s'
8 changes: 4 additions & 4 deletions vale_styles/Google/EnDash.yml
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
extends: existence
message: "Use an em dash ('—') instead of '–'."
link: 'https://developers.google.com/style/dashes'
link: "https://developers.google.com/style/dashes"
nonword: true
level: error
action:
name: edit
params:
- replace
- '-'
- '—'
- "-"
- "—"
tokens:
- '–'
- "–"
2 changes: 1 addition & 1 deletion vale_styles/Google/Exclamation.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
extends: existence
message: "Don't use exclamation points in text."
link: 'https://developers.google.com/style/exclamation-points'
link: "https://developers.google.com/style/exclamation-points"
nonword: true
level: error
tokens:
Expand Down
2 changes: 1 addition & 1 deletion vale_styles/Google/FirstPerson.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
extends: existence
message: "Avoid first-person pronouns such as '%s'."
link: 'https://developers.google.com/style/pronouns#personal-pronouns'
link: "https://developers.google.com/style/pronouns#personal-pronouns"
ignorecase: true
level: warning
nonword: true
Expand Down
2 changes: 1 addition & 1 deletion vale_styles/Google/Gender.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
extends: existence
message: "Don't use '%s' as a gender-neutral pronoun."
link: 'https://developers.google.com/style/pronouns#gender-neutral-pronouns'
link: "https://developers.google.com/style/pronouns#gender-neutral-pronouns"
level: error
ignorecase: true
tokens:
Expand Down
Loading
Loading