diff --git a/src/components/QuickStart.js b/src/components/QuickStart.js
index 7a382a6a8..9c233cc66 100644
--- a/src/components/QuickStart.js
+++ b/src/components/QuickStart.js
@@ -7,7 +7,7 @@ import {FaWindows, FaLinux, FaApple} from "react-icons/fa";
export const QuickStart = () => {
return (
-
+
Welcome to Keploy Documentation! 🚀
diff --git a/src/css/custom.css b/src/css/custom.css
index b40fda1aa..81a7d29ad 100644
--- a/src/css/custom.css
+++ b/src/css/custom.css
@@ -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;
@@ -37,11 +37,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;
@@ -112,7 +111,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,
@@ -164,29 +163,43 @@ div[class^="sidebar_"] .menu__link--sublist.menu__link--active {
}
/* Do NOT bold category when on its own page */
-div[class^="sidebar_"] .menu__list-item-collapsible--active .menu__link--sublist {
+div[class^="sidebar_"]
+ .menu__list-item-collapsible--active
+ .menu__link--sublist {
color: inherit !important;
font-weight: inherit;
}
/* And keep color unchanged even on hover when on its own page */
-div[class^="sidebar_"] .menu__list-item-collapsible--active .menu__link--sublist:hover {
+div[class^="sidebar_"]
+ .menu__list-item-collapsible--active
+ .menu__link--sublist:hover {
color: inherit !important;
}
/* Explicitly neutralize color when category link is both sublist and active (own page) */
-div[class^="sidebar_"] .menu__list-item-collapsible--active .menu__link--sublist.menu__link--active {
+div[class^="sidebar_"]
+ .menu__list-item-collapsible--active
+ .menu__link--sublist.menu__link--active {
color: inherit !important;
}
/* When the category's own page is current, do not change its color/background/weight */
-div[class^="sidebar_"] .menu__list-item-collapsible .menu__link[aria-current="page"] {
+div[class^="sidebar_"]
+ .menu__list-item-collapsible
+ .menu__link[aria-current="page"] {
color: inherit !important;
background: transparent !important;
font-weight: inherit !important;
}
-div[class^="sidebar_"] .menu__list-item-collapsible .menu__link[aria-current="page"]:hover,
-div[class^="sidebar_"] .menu__list-item-collapsible .menu__link[aria-current="page"]:focus,
-div[class^="sidebar_"] .menu__list-item-collapsible .menu__link[aria-current="page"].menu__link--active {
+div[class^="sidebar_"]
+ .menu__list-item-collapsible
+ .menu__link[aria-current="page"]:hover,
+div[class^="sidebar_"]
+ .menu__list-item-collapsible
+ .menu__link[aria-current="page"]:focus,
+div[class^="sidebar_"]
+ .menu__list-item-collapsible
+ .menu__link[aria-current="page"].menu__link--active {
color: inherit !important;
/* prevent extra link-layer background; container provides unified hover */
background-color: transparent !important;
@@ -194,22 +207,35 @@ div[class^="sidebar_"] .menu__list-item-collapsible .menu__link[aria-current="pa
}
/* Strong override: category with its own current page should use normal menu color (not active black) */
-div[class^="sidebar_"] .menu__link--sublist.menu__link--active[aria-current="page"] {
+div[class^="sidebar_"]
+ .menu__link--sublist.menu__link--active[aria-current="page"] {
color: var(--ifm-menu-color) !important;
}
/* Extra-specific guard: ensure normal color for category labels on their own page */
-div[class^="sidebar_"] li.menu__list-item > a.menu__link.menu__link--sublist[aria-current="page"],
-div[class^="sidebar_"] li.menu__list-item > a.menu__link.menu__link--sublist[aria-current="page"].menu__link--active,
-div[class^="sidebar_"] li.menu__list-item > div.menu__list-item-collapsible > a.menu__link.menu__link--sublist[aria-current="page"] {
+div[class^="sidebar_"]
+ li.menu__list-item
+ > a.menu__link.menu__link--sublist[aria-current="page"],
+div[class^="sidebar_"]
+ li.menu__list-item
+ > a.menu__link.menu__link--sublist[aria-current="page"].menu__link--active,
+div[class^="sidebar_"]
+ li.menu__list-item
+ > div.menu__list-item-collapsible
+ > a.menu__link.menu__link--sublist[aria-current="page"] {
color: var(--ifm-menu-color) !important;
background: transparent !important;
font-weight: inherit !important;
}
/* Restore hover background for categories with their own page when hovering that link */
-div[class^="sidebar_"] li.menu__list-item > a.menu__link.menu__link--sublist[aria-current="page"]:hover,
-div[class^="sidebar_"] li.menu__list-item > div.menu__list-item-collapsible > a.menu__link.menu__link--sublist[aria-current="page"]:hover {
+div[class^="sidebar_"]
+ li.menu__list-item
+ > a.menu__link.menu__link--sublist[aria-current="page"]:hover,
+div[class^="sidebar_"]
+ li.menu__list-item
+ > div.menu__list-item-collapsible
+ > a.menu__link.menu__link--sublist[aria-current="page"]:hover {
/* prevent extra link-layer hover; container provides unified hover */
background-color: transparent !important;
}
@@ -219,21 +245,32 @@ div[class^="sidebar_"] li.menu__list-item > div.menu__list-item-collapsible > a.
div[class^="sidebar_"] .menu__list-item-collapsible--active:hover {
background-color: var(--ifm-menu-color-background-hover) !important;
}
-div[class^="sidebar_"] .menu__list-item-collapsible--active:hover > a.menu__link,
-div[class^="sidebar_"] .menu__list-item-collapsible--active:hover > .menu__caret {
+div[class^="sidebar_"]
+ .menu__list-item-collapsible--active:hover
+ > a.menu__link,
+div[class^="sidebar_"]
+ .menu__list-item-collapsible--active:hover
+ > .menu__caret {
background-color: transparent !important;
}
/* For categories with pages (collapsible) when NOT on their page: hover on arrow OR text gives one unified background */
-div[class^="sidebar_"] .menu__list-item-collapsible:not(.menu__list-item-collapsible--active):hover {
+div[class^="sidebar_"]
+ .menu__list-item-collapsible:not(.menu__list-item-collapsible--active):hover {
background-color: var(--ifm-menu-color-background-hover) !important;
}
-div[class^="sidebar_"] .menu__list-item-collapsible:not(.menu__list-item-collapsible--active):hover > a.menu__link,
-div[class^="sidebar_"] .menu__list-item-collapsible:not(.menu__list-item-collapsible--active):hover > .menu__caret {
+div[class^="sidebar_"]
+ .menu__list-item-collapsible:not(.menu__list-item-collapsible--active):hover
+ > a.menu__link,
+div[class^="sidebar_"]
+ .menu__list-item-collapsible:not(.menu__list-item-collapsible--active):hover
+ > .menu__caret {
background-color: transparent !important;
}
/* Ensure link text color does not change on hover in this specific case */
-div[class^="sidebar_"] .menu__list-item-collapsible--active:hover > a.menu__link {
+div[class^="sidebar_"]
+ .menu__list-item-collapsible--active:hover
+ > a.menu__link {
color: inherit !important;
}
@@ -242,11 +279,13 @@ div[class^="sidebar_"] .menu__list-item-collapsible--active {
background: transparent !important;
}
-
/* Parent style when a child page is active is handled below for light mode (orange) */
/* Light mode: use orange color (no bold) for parent when a child page is active */
-html[data-theme="light"] div[class^="sidebar_"] .menu__list-item-collapsible:not(.menu__list-item-collapsible--active) .menu__link--sublist.menu__link--active {
+html[data-theme="light"]
+ div[class^="sidebar_"]
+ .menu__list-item-collapsible:not(.menu__list-item-collapsible--active)
+ .menu__link--sublist.menu__link--active {
color: var(--ifm-color-primary) !important;
font-weight: inherit;
}
@@ -329,7 +368,7 @@ div[class^="sidebar_"] .menu__link.menu__link--active {
/* Pagination */
.pagination-nav {
- @apply flex mt-12 flex-col items-start justify-center space-x-0 space-y-5 md:flex-row md:space-x-10 md:space-y-0;
+ @apply mt-12 flex flex-col items-start justify-center space-x-0 space-y-5 md:flex-row md:space-x-10 md:space-y-0;
}
.pagination-nav__item {
@apply w-full max-w-md;
@@ -344,7 +383,7 @@ div[class^="sidebar_"] .menu__link.menu__link--active {
}
.navbar__items--right {
- @apply justify-end ml-auto flex-row-reverse;
+ @apply ml-auto flex-row-reverse justify-end;
gap: 13px;
}
@@ -376,13 +415,48 @@ footer svg {
}
.footer .footer__svg {
- @apply m-8 inline fill-current;
+ @apply inline fill-current;
+ margin: 0.75rem;
}
.footer .footer__link-item span svg {
@apply hidden;
}
+.footer__content {
+ display: flex;
+ flex-direction: column;
+ align-items: center;
+ gap: 18px;
+ padding: 0 18px;
+ text-align: center;
+}
+
+.footer__icons {
+ display: flex;
+ flex-wrap: wrap;
+ justify-content: center;
+ gap: 24px;
+}
+
+.footer__icons .footer__svg {
+ margin: 0.75rem;
+}
+
+.footer__links {
+ display: flex;
+ flex-wrap: wrap;
+ justify-content: center;
+ gap: 12px;
+}
+
+.footer__links .footer__link-item:not(:last-child)::after {
+ content: "|";
+ margin-left: 12px;
+ color: inherit;
+ opacity: 0.6;
+}
+
@media (max-width: 996px) {
.footer .footer__separators {
display: none;
@@ -392,6 +466,22 @@ footer svg {
@apply mr-2 !important;
}
+ .footer__icons {
+ gap: 16px;
+ }
+
+ .footer__icons .footer__svg {
+ margin: 0.5rem;
+ }
+
+ .footer__links {
+ flex-direction: row;
+ flex-wrap: wrap;
+ align-items: center;
+ justify-content: center;
+ gap: 10px;
+ }
+
/* .footer .footer__block {
display: block;
} */
@@ -414,6 +504,19 @@ footer svg {
}
.docs-image-max-width-20 {
+ .footer__icons {
+ gap: 16px;
+ }
+
+ .footer__icons .footer__svg {
+ margin: 0.5rem;
+ }
+
+ .footer__links {
+ flex-direction: column;
+ align-items: center;
+ gap: 6px;
+ }
width: 20%;
}
@@ -452,7 +555,7 @@ footer svg {
}
/* Reset margin bottom on h3 (refer docs community section li item heading) after disabling tailwind preflight. */
-h3{
+h3 {
margin-bottom: 1px;
}
@@ -720,13 +823,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);
}
* {
@@ -739,7 +843,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 {
@@ -793,9 +897,9 @@ html {
}
button,
-[type='button'],
-[type='reset'],
-[type='submit'] {
+[type="button"],
+[type="reset"],
+[type="submit"] {
-webkit-appearance: button;
background-color: transparent;
background-image: none;
@@ -822,12 +926,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;
}
@@ -861,7 +965,7 @@ textarea {
}
.theme-back-to-top-button {
- background-color: #FF914D !important;
+ background-color: #ff914d !important;
color: white !important;
}
@@ -872,5 +976,3 @@ textarea {
.theme-back-to-top-button:hover {
background-color: #e67643 !important;
}
-
-
diff --git a/src/pages/index.js b/src/pages/index.js
index d473b88f3..3021c0fb8 100644
--- a/src/pages/index.js
+++ b/src/pages/index.js
@@ -77,11 +77,11 @@ export default function Home() {
)}
-
+
{/* */}
{/**/}
diff --git a/src/pages/styles.module.css b/src/pages/styles.module.css
index bae51321e..70eac6e9d 100644
--- a/src/pages/styles.module.css
+++ b/src/pages/styles.module.css
@@ -159,4 +159,4 @@
.announcementInner {
margin: 0 auto;
max-width: 768px;
-}
\ No newline at end of file
+}
diff --git a/src/theme/Heading/styles.module.css b/src/theme/Heading/styles.module.css
index ba959ca0e..9cd0e73c2 100644
--- a/src/theme/Heading/styles.module.css
+++ b/src/theme/Heading/styles.module.css
@@ -19,7 +19,7 @@ See https://twitter.com/JoshWComeau/status/1332015868725891076
}
:global(.hash-link::before) {
- content: '#';
+ content: "#";
}
:global(.hash-link:focus),
diff --git a/static/css/code-block-buttons.css b/static/css/code-block-buttons.css
index 3440bb7df..6e295df35 100644
--- a/static/css/code-block-buttons.css
+++ b/static/css/code-block-buttons.css
@@ -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;
- }
\ No newline at end of file
+ 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;
+}
diff --git a/vale_styles/Google/AMPM.yml b/vale_styles/Google/AMPM.yml
index fbdc6e4f8..518e1d4dc 100644
--- a/vale_styles/Google/AMPM.yml
+++ b/vale_styles/Google/AMPM.yml
@@ -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:
diff --git a/vale_styles/Google/Acronyms.yml b/vale_styles/Google/Acronyms.yml
index f41af0189..acfa940d2 100644
--- a/vale_styles/Google/Acronyms.yml
+++ b/vale_styles/Google/Acronyms.yml
@@ -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'.
diff --git a/vale_styles/Google/Colons.yml b/vale_styles/Google/Colons.yml
index 99363fbd4..fcbeaa798 100644
--- a/vale_styles/Google/Colons.yml
+++ b/vale_styles/Google/Colons.yml
@@ -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
diff --git a/vale_styles/Google/Contractions.yml b/vale_styles/Google/Contractions.yml
index 95234987b..4dd4c258f 100644
--- a/vale_styles/Google/Contractions.yml
+++ b/vale_styles/Google/Contractions.yml
@@ -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:
diff --git a/vale_styles/Google/DateFormat.yml b/vale_styles/Google/DateFormat.yml
index e9d227fa1..168aa4c57 100644
--- a/vale_styles/Google/DateFormat.yml
+++ b/vale_styles/Google/DateFormat.yml
@@ -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
diff --git a/vale_styles/Google/Ellipses.yml b/vale_styles/Google/Ellipses.yml
index 1e070517b..4e906228e 100644
--- a/vale_styles/Google/Ellipses.yml
+++ b/vale_styles/Google/Ellipses.yml
@@ -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:
diff --git a/vale_styles/Google/EmDash.yml b/vale_styles/Google/EmDash.yml
index 1befe72aa..9cb0464e1 100644
--- a/vale_styles/Google/EmDash.yml
+++ b/vale_styles/Google/EmDash.yml
@@ -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'
diff --git a/vale_styles/Google/EnDash.yml b/vale_styles/Google/EnDash.yml
index b314dc4e9..ec23a87ab 100644
--- a/vale_styles/Google/EnDash.yml
+++ b/vale_styles/Google/EnDash.yml
@@ -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:
- - '–'
+ - "–"
diff --git a/vale_styles/Google/Exclamation.yml b/vale_styles/Google/Exclamation.yml
index 3e15181b2..e10c3263b 100644
--- a/vale_styles/Google/Exclamation.yml
+++ b/vale_styles/Google/Exclamation.yml
@@ -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:
diff --git a/vale_styles/Google/FirstPerson.yml b/vale_styles/Google/FirstPerson.yml
index 0b7b8828c..21a074dce 100644
--- a/vale_styles/Google/FirstPerson.yml
+++ b/vale_styles/Google/FirstPerson.yml
@@ -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
diff --git a/vale_styles/Google/Gender.yml b/vale_styles/Google/Gender.yml
index c8486181d..5eda946ba 100644
--- a/vale_styles/Google/Gender.yml
+++ b/vale_styles/Google/Gender.yml
@@ -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:
diff --git a/vale_styles/Google/GenderBias.yml b/vale_styles/Google/GenderBias.yml
index 261cfb666..8a21b5c75 100644
--- a/vale_styles/Google/GenderBias.yml
+++ b/vale_styles/Google/GenderBias.yml
@@ -1,45 +1,45 @@
extends: substitution
message: "Consider using '%s' instead of '%s'."
-link: 'https://developers.google.com/style/inclusive-documentation'
+link: "https://developers.google.com/style/inclusive-documentation"
ignorecase: true
level: error
swap:
- (?:alumna|alumnus): graduate
- (?:alumnae|alumni): graduates
- air(?:m[ae]n|wom[ae]n): pilot(s)
- anchor(?:m[ae]n|wom[ae]n): anchor(s)
- authoress: author
- camera(?:m[ae]n|wom[ae]n): camera operator(s)
- chair(?:m[ae]n|wom[ae]n): chair(s)
+ (?:alumna|alumnus): graduate
+ (?:alumnae|alumni): graduates
+ air(?:m[ae]n|wom[ae]n): pilot(s)
+ anchor(?:m[ae]n|wom[ae]n): anchor(s)
+ authoress: author
+ camera(?:m[ae]n|wom[ae]n): camera operator(s)
+ chair(?:m[ae]n|wom[ae]n): chair(s)
congress(?:m[ae]n|wom[ae]n): member(s) of congress
- door(?:m[ae]|wom[ae]n): concierge(s)
- draft(?:m[ae]n|wom[ae]n): drafter(s)
- fire(?:m[ae]n|wom[ae]n): firefighter(s)
- fisher(?:m[ae]n|wom[ae]n): fisher(s)
- fresh(?:m[ae]n|wom[ae]n): first-year student(s)
- garbage(?:m[ae]n|wom[ae]n): waste collector(s)
- lady lawyer: lawyer
- ladylike: courteous
- landlord: building manager
- mail(?:m[ae]n|wom[ae]n): mail carriers
- man and wife: husband and wife
- man enough: strong enough
- mankind: human kind
- manmade: manufactured
- manpower: personnel
- men and girls: men and women
- middle(?:m[ae]n|wom[ae]n): intermediary
- news(?:m[ae]n|wom[ae]n): journalist(s)
- ombuds(?:man|woman): ombuds
- oneupmanship: upstaging
- poetess: poet
- police(?:m[ae]n|wom[ae]n): police officer(s)
- repair(?:m[ae]n|wom[ae]n): technician(s)
- sales(?:m[ae]n|wom[ae]n): salesperson or sales people
- service(?:m[ae]n|wom[ae]n): soldier(s)
- steward(?:ess)?: flight attendant
- tribes(?:m[ae]n|wom[ae]n): tribe member(s)
- waitress: waiter
- woman doctor: doctor
- woman scientist[s]?: scientist(s)
- work(?:m[ae]n|wom[ae]n): worker(s)
+ door(?:m[ae]|wom[ae]n): concierge(s)
+ draft(?:m[ae]n|wom[ae]n): drafter(s)
+ fire(?:m[ae]n|wom[ae]n): firefighter(s)
+ fisher(?:m[ae]n|wom[ae]n): fisher(s)
+ fresh(?:m[ae]n|wom[ae]n): first-year student(s)
+ garbage(?:m[ae]n|wom[ae]n): waste collector(s)
+ lady lawyer: lawyer
+ ladylike: courteous
+ landlord: building manager
+ mail(?:m[ae]n|wom[ae]n): mail carriers
+ man and wife: husband and wife
+ man enough: strong enough
+ mankind: human kind
+ manmade: manufactured
+ manpower: personnel
+ men and girls: men and women
+ middle(?:m[ae]n|wom[ae]n): intermediary
+ news(?:m[ae]n|wom[ae]n): journalist(s)
+ ombuds(?:man|woman): ombuds
+ oneupmanship: upstaging
+ poetess: poet
+ police(?:m[ae]n|wom[ae]n): police officer(s)
+ repair(?:m[ae]n|wom[ae]n): technician(s)
+ sales(?:m[ae]n|wom[ae]n): salesperson or sales people
+ service(?:m[ae]n|wom[ae]n): soldier(s)
+ steward(?:ess)?: flight attendant
+ tribes(?:m[ae]n|wom[ae]n): tribe member(s)
+ waitress: waiter
+ woman doctor: doctor
+ woman scientist[s]?: scientist(s)
+ work(?:m[ae]n|wom[ae]n): worker(s)
diff --git a/vale_styles/Google/HeadingPunctuation.yml b/vale_styles/Google/HeadingPunctuation.yml
index b538be5b4..7202aa56a 100644
--- a/vale_styles/Google/HeadingPunctuation.yml
+++ b/vale_styles/Google/HeadingPunctuation.yml
@@ -1,6 +1,6 @@
extends: existence
message: "Don't put a period at the end of a heading."
-link: 'https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings'
+link: "https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings"
nonword: true
level: warning
scope: heading
@@ -8,6 +8,6 @@ action:
name: edit
params:
- remove
- - '.'
+ - "."
tokens:
- '[a-z0-9][.]\s*$'
diff --git a/vale_styles/Google/Headings.yml b/vale_styles/Google/Headings.yml
index a53301338..18e2f17f3 100644
--- a/vale_styles/Google/Headings.yml
+++ b/vale_styles/Google/Headings.yml
@@ -1,11 +1,11 @@
extends: capitalization
message: "'%s' should use sentence-style capitalization."
-link: 'https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings'
+link: "https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings"
level: warning
scope: heading
match: $sentence
indicators:
- - ':'
+ - ":"
exceptions:
- Azure
- CLI
diff --git a/vale_styles/Google/Latin.yml b/vale_styles/Google/Latin.yml
index d91700de3..3ad563c45 100644
--- a/vale_styles/Google/Latin.yml
+++ b/vale_styles/Google/Latin.yml
@@ -1,6 +1,6 @@
extends: substitution
message: "Use '%s' instead of '%s'."
-link: 'https://developers.google.com/style/abbreviations'
+link: "https://developers.google.com/style/abbreviations"
ignorecase: true
level: error
nonword: true
diff --git a/vale_styles/Google/LyHyphens.yml b/vale_styles/Google/LyHyphens.yml
index ac8f557a4..5c8193491 100644
--- a/vale_styles/Google/LyHyphens.yml
+++ b/vale_styles/Google/LyHyphens.yml
@@ -1,6 +1,6 @@
extends: existence
message: "'%s' doesn't need a hyphen."
-link: 'https://developers.google.com/style/hyphens'
+link: "https://developers.google.com/style/hyphens"
level: error
ignorecase: false
nonword: true
@@ -8,7 +8,7 @@ action:
name: edit
params:
- replace
- - '-'
- - ' '
+ - "-"
+ - " "
tokens:
- '\s[^\s-]+ly-'
diff --git a/vale_styles/Google/OptionalPlurals.yml b/vale_styles/Google/OptionalPlurals.yml
index f858ea6fe..0465e2d8c 100644
--- a/vale_styles/Google/OptionalPlurals.yml
+++ b/vale_styles/Google/OptionalPlurals.yml
@@ -1,12 +1,12 @@
extends: existence
message: "Don't use plurals in parentheses such as in '%s'."
-link: 'https://developers.google.com/style/plurals-parentheses'
+link: "https://developers.google.com/style/plurals-parentheses"
level: error
nonword: true
action:
name: edit
params:
- remove
- - '(s)'
+ - "(s)"
tokens:
- '\b\w+\(s\)'
diff --git a/vale_styles/Google/Ordinal.yml b/vale_styles/Google/Ordinal.yml
index d1ac7d27e..2e75b8dcb 100644
--- a/vale_styles/Google/Ordinal.yml
+++ b/vale_styles/Google/Ordinal.yml
@@ -1,6 +1,6 @@
extends: existence
message: "Spell out all ordinal numbers ('%s') in text."
-link: 'https://developers.google.com/style/numbers'
+link: "https://developers.google.com/style/numbers"
level: error
nonword: true
tokens:
diff --git a/vale_styles/Google/OxfordComma.yml b/vale_styles/Google/OxfordComma.yml
index b9ba21ebb..5bd5faf04 100644
--- a/vale_styles/Google/OxfordComma.yml
+++ b/vale_styles/Google/OxfordComma.yml
@@ -1,6 +1,6 @@
extends: existence
message: "Use the Oxford comma in '%s'."
-link: 'https://developers.google.com/style/commas'
+link: "https://developers.google.com/style/commas"
scope: sentence
level: warning
tokens:
diff --git a/vale_styles/Google/Parens.yml b/vale_styles/Google/Parens.yml
index 3b8711d0c..7c7eb0fc5 100644
--- a/vale_styles/Google/Parens.yml
+++ b/vale_styles/Google/Parens.yml
@@ -1,6 +1,6 @@
extends: existence
message: "Use parentheses judiciously."
-link: 'https://developers.google.com/style/parentheses'
+link: "https://developers.google.com/style/parentheses"
nonword: true
level: suggestion
tokens:
diff --git a/vale_styles/Google/Passive.yml b/vale_styles/Google/Passive.yml
index 3265890e5..b7b1dd225 100644
--- a/vale_styles/Google/Passive.yml
+++ b/vale_styles/Google/Passive.yml
@@ -1,5 +1,5 @@
extends: existence
-link: 'https://developers.google.com/style/voice'
+link: "https://developers.google.com/style/voice"
message: "In general, use active voice instead of passive voice ('%s')."
ignorecase: true
level: suggestion
diff --git a/vale_styles/Google/Periods.yml b/vale_styles/Google/Periods.yml
index d24a6a6c0..9bbf9e81b 100644
--- a/vale_styles/Google/Periods.yml
+++ b/vale_styles/Google/Periods.yml
@@ -1,6 +1,6 @@
extends: existence
message: "Don't use periods with acronyms or initialisms such as '%s'."
-link: 'https://developers.google.com/style/abbreviations'
+link: "https://developers.google.com/style/abbreviations"
level: error
nonword: true
tokens:
diff --git a/vale_styles/Google/Quotes.yml b/vale_styles/Google/Quotes.yml
index 3cb6f1abd..44118f942 100644
--- a/vale_styles/Google/Quotes.yml
+++ b/vale_styles/Google/Quotes.yml
@@ -1,6 +1,6 @@
extends: existence
message: "Commas and periods go inside quotation marks."
-link: 'https://developers.google.com/style/quotation-marks'
+link: "https://developers.google.com/style/quotation-marks"
level: error
nonword: true
tokens:
diff --git a/vale_styles/Google/Ranges.yml b/vale_styles/Google/Ranges.yml
index 3ec045e77..8469d92e9 100644
--- a/vale_styles/Google/Ranges.yml
+++ b/vale_styles/Google/Ranges.yml
@@ -1,6 +1,6 @@
extends: existence
message: "Don't add words such as 'from' or 'between' to describe a range of numbers."
-link: 'https://developers.google.com/style/hyphens'
+link: "https://developers.google.com/style/hyphens"
nonword: true
level: warning
tokens:
diff --git a/vale_styles/Google/Semicolons.yml b/vale_styles/Google/Semicolons.yml
index bb8b85b42..65586ab74 100644
--- a/vale_styles/Google/Semicolons.yml
+++ b/vale_styles/Google/Semicolons.yml
@@ -1,8 +1,8 @@
extends: existence
message: "Use semicolons judiciously."
-link: 'https://developers.google.com/style/semicolons'
+link: "https://developers.google.com/style/semicolons"
nonword: true
scope: sentence
level: suggestion
tokens:
- - ';'
+ - ";"
diff --git a/vale_styles/Google/Slang.yml b/vale_styles/Google/Slang.yml
index 63f4c248a..802f81968 100644
--- a/vale_styles/Google/Slang.yml
+++ b/vale_styles/Google/Slang.yml
@@ -1,10 +1,10 @@
extends: existence
message: "Don't use internet slang abbreviations such as '%s'."
-link: 'https://developers.google.com/style/abbreviations'
+link: "https://developers.google.com/style/abbreviations"
ignorecase: true
level: error
tokens:
- - 'tl;dr'
+ - "tl;dr"
- ymmv
- rtfm
- imo
diff --git a/vale_styles/Google/Spacing.yml b/vale_styles/Google/Spacing.yml
index 27f7ca2bd..dfc27be41 100644
--- a/vale_styles/Google/Spacing.yml
+++ b/vale_styles/Google/Spacing.yml
@@ -1,8 +1,8 @@
extends: existence
message: "'%s' should have one space."
-link: 'https://developers.google.com/style/sentence-spacing'
+link: "https://developers.google.com/style/sentence-spacing"
level: error
nonword: true
tokens:
- - '[a-z][.?!] {2,}[A-Z]'
- - '[a-z][.?!][A-Z]'
+ - "[a-z][.?!] {2,}[A-Z]"
+ - "[a-z][.?!][A-Z]"
diff --git a/vale_styles/Google/Spelling.yml b/vale_styles/Google/Spelling.yml
index 57acb8841..3d62d448e 100644
--- a/vale_styles/Google/Spelling.yml
+++ b/vale_styles/Google/Spelling.yml
@@ -1,6 +1,6 @@
extends: existence
message: "In general, use American spelling instead of '%s'."
-link: 'https://developers.google.com/style/spelling'
+link: "https://developers.google.com/style/spelling"
ignorecase: true
level: warning
tokens:
diff --git a/vale_styles/Google/Units.yml b/vale_styles/Google/Units.yml
index 379fad6b8..8c2f4c83d 100644
--- a/vale_styles/Google/Units.yml
+++ b/vale_styles/Google/Units.yml
@@ -1,6 +1,6 @@
extends: existence
message: "Put a nonbreaking space between the number and the unit in '%s'."
-link: 'https://developers.google.com/style/units-of-measure'
+link: "https://developers.google.com/style/units-of-measure"
nonword: true
level: error
tokens:
diff --git a/vale_styles/Google/We.yml b/vale_styles/Google/We.yml
index c7ac7d362..0fdbf869d 100644
--- a/vale_styles/Google/We.yml
+++ b/vale_styles/Google/We.yml
@@ -1,6 +1,6 @@
extends: existence
message: "Try to avoid using first-person plural like '%s'."
-link: 'https://developers.google.com/style/pronouns#personal-pronouns'
+link: "https://developers.google.com/style/pronouns#personal-pronouns"
level: warning
ignorecase: true
tokens:
diff --git a/vale_styles/Google/Will.yml b/vale_styles/Google/Will.yml
index 128a91836..d94cc0492 100644
--- a/vale_styles/Google/Will.yml
+++ b/vale_styles/Google/Will.yml
@@ -1,6 +1,6 @@
extends: existence
message: "Avoid using '%s'."
-link: 'https://developers.google.com/style/tense'
+link: "https://developers.google.com/style/tense"
ignorecase: true
level: warning
tokens:
diff --git a/vale_styles/Google/WordList.yml b/vale_styles/Google/WordList.yml
index bb711517e..d89ed39f7 100644
--- a/vale_styles/Google/WordList.yml
+++ b/vale_styles/Google/WordList.yml
@@ -1,25 +1,25 @@
extends: substitution
message: "Use '%s' instead of '%s'."
-link: 'https://developers.google.com/style/word-list'
+link: "https://developers.google.com/style/word-list"
level: warning
ignorecase: false
action:
name: replace
swap:
- '(?:API Console|dev|developer) key': API key
- '(?:cell ?phone|smart ?phone)': phone|mobile phone
- '(?:dev|developer|APIs) console': API console
- '(?:e-mail|Email|E-mail)': email
- '(?:file ?path|path ?name)': path
- '(?:kill|terminate|abort)': stop|exit|cancel|end
- '(?:OAuth ?2|Oauth)': OAuth 2.0
- '(?:ok|Okay)': OK|okay
- '(?:WiFi|wifi)': Wi-Fi
+ "(?:API Console|dev|developer) key": API key
+ "(?:cell ?phone|smart ?phone)": phone|mobile phone
+ "(?:dev|developer|APIs) console": API console
+ "(?:e-mail|Email|E-mail)": email
+ "(?:file ?path|path ?name)": path
+ "(?:kill|terminate|abort)": stop|exit|cancel|end
+ "(?:OAuth ?2|Oauth)": OAuth 2.0
+ "(?:ok|Okay)": OK|okay
+ "(?:WiFi|wifi)": Wi-Fi
'[\.]+apk': APK
'3\-D': 3D
'Google (?:I\-O|IO)': Google I/O
- 'tap (?:&|and) hold': touch & hold
- 'un(?:check|select)': clear
+ "tap (?:&|and) hold": touch & hold
+ "un(?:check|select)": clear
above: preceding
account name: username
action bar: app bar
@@ -75,6 +75,6 @@ swap:
tablename: table name
tablet: device
touch: tap
- url: URL
+ url: URL
vs\.: versus
World Wide Web: web
diff --git a/versioned_sidebars/version-1.0.0-sidebars.json b/versioned_sidebars/version-1.0.0-sidebars.json
index 4f32fd178..2e2d72989 100644
--- a/versioned_sidebars/version-1.0.0-sidebars.json
+++ b/versioned_sidebars/version-1.0.0-sidebars.json
@@ -15,10 +15,7 @@
"label": "Installation",
"collapsible": true,
"collapsed": false,
- "items": [
- "server/server-installation",
- "server/sdk-installation"
- ]
+ "items": ["server/server-installation", "server/sdk-installation"]
},
{
"type": "category",
@@ -140,9 +137,7 @@
"type": "doc",
"id": "java/quickstart/index"
},
- "items": [
- "java/quickstart/spring-sql"
- ]
+ "items": ["java/quickstart/spring-sql"]
},
{
"type": "link",
diff --git a/versioned_sidebars/version-3.0.0-sidebars.json b/versioned_sidebars/version-3.0.0-sidebars.json
index 5ab6d0a00..05a5c891a 100644
--- a/versioned_sidebars/version-3.0.0-sidebars.json
+++ b/versioned_sidebars/version-3.0.0-sidebars.json
@@ -114,20 +114,14 @@
"label": "C# (.NET Core)",
"collapsible": true,
"collapsed": true,
- "items": [
- "quickstart/samples-csharp"
- ]
+ "items": ["quickstart/samples-csharp"]
}
]
},
{
"type": "category",
"label": "CI/CD Integration",
- "items": [
- "ci-cd/github",
- "ci-cd/gitlab",
- "ci-cd/jenkins"
- ]
+ "items": ["ci-cd/github", "ci-cd/gitlab", "ci-cd/jenkins"]
},
{
"type": "category",
@@ -210,4 +204,4 @@
]
}
]
-}
\ No newline at end of file
+}
diff --git a/versions.json b/versions.json
index ef6f17a0c..ce55d2648 100644
--- a/versions.json
+++ b/versions.json
@@ -1,5 +1 @@
-[
- "3.0.0",
- "2.0.0",
- "1.0.0"
-]
\ No newline at end of file
+["3.0.0", "2.0.0", "1.0.0"]