From 716c4dbdb37c4e71726bf6b9b05eeab85ec733f5 Mon Sep 17 00:00:00 2001 From: Robin Marillia Date: Fri, 5 Aug 2022 23:29:57 +0200 Subject: [PATCH 01/37] fix: better anchor colors from Primer primitives --- docs/custom.css | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/custom.css b/docs/custom.css index cd8c7f2d..00aa09f3 100644 --- a/docs/custom.css +++ b/docs/custom.css @@ -14,6 +14,7 @@ html[data-prefers-color-scheme=light] { --color-bg-canvas-tertiary: #f6f8fa; --color-text-primary: #24292e; --color-markdown-code-bg: rgba(27, 31, 35, 0.05); + --color-accent-fg: #0969da; } /* Prefers dark */ html[data-prefers-color-scheme=dark] { @@ -22,6 +23,7 @@ html[data-prefers-color-scheme=dark] { --color-bg-canvas-tertiary: #161b22; --color-text-primary: #c9d1d9; --color-markdown-code-bg: rgba(240, 246, 252, 0.05); + --color-accent-fg: #58a6ff; } @media (prefers-color-scheme: dark) { :root:not([data-prefers-color-scheme=light]) { @@ -30,6 +32,7 @@ html[data-prefers-color-scheme=dark] { --color-bg-canvas-tertiary: #161b22; --color-text-primary: #c9d1d9; --color-markdown-code-bg: rgba(240, 246, 252, 0.05); + --color-accent-fg: #58a6ff; } } @@ -38,6 +41,10 @@ body { color: var(--color-text-primary); } +a { + color: var(--color-accent-fg) +} + /* Sidebar */ /* NB: `!important` is already used; so it’s required here */ .bg-gray { background-color: var(--color-bg-canvas-tertiary) !important } From 7c5312e3c605d5d3dd2effb2120d5ff2a22690e0 Mon Sep 17 00:00:00 2001 From: robin marillia Date: Fri, 12 Aug 2022 13:35:44 +0100 Subject: [PATCH 02/37] feat: add links for prev and next guide page --- docs/_layouts/guide.html | 17 ++++++-- docs/custom.css | 88 ++++++++++++++++++++++++++++++++-------- 2 files changed, 85 insertions(+), 20 deletions(-) diff --git a/docs/_layouts/guide.html b/docs/_layouts/guide.html index 859de798..18381866 100644 --- a/docs/_layouts/guide.html +++ b/docs/_layouts/guide.html @@ -3,14 +3,25 @@ ---
- {% assign sidebarItems = site.guide | sort: 'chapter' %} - {% include sidebar.html %} + {% assign sidebarItems = site.guide | sort: 'chapter' %} {% include sidebar.html %}

{{ page.title }}

{{ content }} +
+ {% if page.previous %} + + Previous + {{page.previous.subtitle}} + + {% endif %} {% if page.next %} + + Next + {{page.next.subtitle}} + + {% endif %} +
-
diff --git a/docs/custom.css b/docs/custom.css index 00aa09f3..2ca4bcd3 100644 --- a/docs/custom.css +++ b/docs/custom.css @@ -1,14 +1,29 @@ -pre { font-size: 100% !important } -code { font-size: 90% !important } +pre { + font-size: 100% !important; +} +code { + font-size: 90% !important; +} -h1, h2, h3, h4, h5 { margin: 1rem 0; width: 100%; } -ul li { margin-left: 1rem } +h1, +h2, +h3, +h4, +h5 { + margin: 1rem 0; + width: 100%; +} +ul li { + margin-left: 1rem; +} -.top-100px { top: 100px } +.top-100px { + top: 100px; +} /* No preference or prefers light */ -:root:not([data-prefers-color-scheme=dark]), -html[data-prefers-color-scheme=light] { +:root:not([data-prefers-color-scheme='dark']), +html[data-prefers-color-scheme='light'] { --color-bg-canvas: rgb(255, 255, 255); --color-bg-canvas-shadow: rgba(255, 255, 255, 0); --color-bg-canvas-tertiary: #f6f8fa; @@ -17,7 +32,7 @@ html[data-prefers-color-scheme=light] { --color-accent-fg: #0969da; } /* Prefers dark */ -html[data-prefers-color-scheme=dark] { +html[data-prefers-color-scheme='dark'] { --color-bg-canvas: rgb(13, 17, 23); --color-bg-canvas-shadow: rgba(13, 17, 23, 0); --color-bg-canvas-tertiary: #161b22; @@ -26,7 +41,7 @@ html[data-prefers-color-scheme=dark] { --color-accent-fg: #58a6ff; } @media (prefers-color-scheme: dark) { - :root:not([data-prefers-color-scheme=light]) { + :root:not([data-prefers-color-scheme='light']) { --color-bg-canvas: rgb(13, 17, 23); --color-bg-canvas-shadow: rgba(13, 17, 23, 0); --color-bg-canvas-tertiary: #161b22; @@ -42,30 +57,69 @@ body { } a { - color: var(--color-accent-fg) + color: var(--color-accent-fg); } /* Sidebar */ /* NB: `!important` is already used; so it’s required here */ -.bg-gray { background-color: var(--color-bg-canvas-tertiary) !important } +.bg-gray { + background-color: var(--color-bg-canvas-tertiary) !important; +} /* Code Blocks & Syntax */ -.markdown-body .highlight pre, .markdown-body pre { +.markdown-body .highlight pre, +.markdown-body pre { background-color: var(--color-bg-canvas-tertiary); overflow: auto; } /* Inline Code */ -.markdown-body code, .markdown-body tt { background-color: var(--color-markdown-code-bg) } +.markdown-body code, +.markdown-body tt { + background-color: var(--color-markdown-code-bg); +} /* Tables */ -.markdown-body table tr:nth-of-type(odd) th, .markdown-body table tr:nth-of-type(odd) td { background-color: var(--color-bg-canvas) } -.markdown-body table tr:nth-of-type(even) th, .markdown-body table tr:nth-of-type(even) td { background-color: var(--color-bg-canvas-tertiary) } +.markdown-body table tr:nth-of-type(odd) th, +.markdown-body table tr:nth-of-type(odd) td { + background-color: var(--color-bg-canvas); +} +.markdown-body table tr:nth-of-type(even) th, +.markdown-body table tr:nth-of-type(even) td { + background-color: var(--color-bg-canvas-tertiary); +} /* Override Primer .tooltipped default aria-label */ -.code-tooltip:after { content: attr(data-title); text-align: left; font-size: 100%; } +.code-tooltip:after { + content: attr(data-title); + text-align: left; + font-size: 100%; +} /* :after text will be announced by AT, this adds a separation between textContent and :after text */ -.code-tooltip:before { content: ': '; font-size: 0; } +.code-tooltip:before { + content: ': '; + font-size: 0; +} .code-tooltip { scroll-margin-top: 150px; } + +/* Prev next links */ +.prev-next-link { + border-radius: 8px; + border: solid 1px; + padding: 16px; +} + +.prev-next-link:hover { + border-color: var(--color-accent-fg); +} + +.prev-next-link__label { + text-transform: uppercase; + font-size: 12px; +} + +.prev-next-link__name { + color: red; +} From da8c189dd3d611500469634978f835484f57ea49 Mon Sep 17 00:00:00 2001 From: robin marillia Date: Sun, 14 Aug 2022 16:48:05 +0200 Subject: [PATCH 03/37] feat: add pagination component --- docs/_layouts/guide.html | 26 ++++++++++++++------------ docs/custom.css | 20 -------------------- 2 files changed, 14 insertions(+), 32 deletions(-) diff --git a/docs/_layouts/guide.html b/docs/_layouts/guide.html index 18381866..1c64ab7c 100644 --- a/docs/_layouts/guide.html +++ b/docs/_layouts/guide.html @@ -9,18 +9,20 @@

{{ page.title }}

{{ content }} -
- {% if page.previous %} - - Previous - {{page.previous.subtitle}} - - {% endif %} {% if page.next %} - - Next - {{page.next.subtitle}} - - {% endif %} +
+
diff --git a/docs/custom.css b/docs/custom.css index 2ca4bcd3..b2c5a386 100644 --- a/docs/custom.css +++ b/docs/custom.css @@ -103,23 +103,3 @@ a { .code-tooltip { scroll-margin-top: 150px; } - -/* Prev next links */ -.prev-next-link { - border-radius: 8px; - border: solid 1px; - padding: 16px; -} - -.prev-next-link:hover { - border-color: var(--color-accent-fg); -} - -.prev-next-link__label { - text-transform: uppercase; - font-size: 12px; -} - -.prev-next-link__name { - color: red; -} From e0b70605d0a1c6fd57a570e77516b848250420cb Mon Sep 17 00:00:00 2001 From: Robin Marillia Date: Mon, 15 Aug 2022 19:17:53 +0200 Subject: [PATCH 04/37] add working prev and next links --- docs/Gemfile.lock | 1 + docs/_layouts/guide.html | 43 +++++++++++++++++++++++++++------------- docs/custom.css | 14 +++++++++++++ 3 files changed, 44 insertions(+), 14 deletions(-) diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock index 3b3e7f35..350cb83f 100644 --- a/docs/Gemfile.lock +++ b/docs/Gemfile.lock @@ -98,6 +98,7 @@ GEM faraday (> 0.8, < 2.0) PLATFORMS + universal-darwin-21 x86_64-linux DEPENDENCIES diff --git a/docs/_layouts/guide.html b/docs/_layouts/guide.html index 1c64ab7c..45c1856d 100644 --- a/docs/_layouts/guide.html +++ b/docs/_layouts/guide.html @@ -2,26 +2,41 @@ layout: default --- +{% assign sidebarItems = site.guide | sort: 'chapter' %} + +{% for item in sidebarItems %} + {% if item.title == page.title %} + {% unless forloop.first %} + {% assign prevIndex = forloop.index| minus: 2 %} + {% assign prev = sidebarItems[prevIndex] %} + {% endunless %} + {% unless forloop.last %} + {% assign nextIndex = forloop.index %} + {% assign next = sidebarItems[nextIndex] %} + {% endunless %} + {% endif %} +{% endfor %} +
- {% assign sidebarItems = site.guide | sort: 'chapter' %} {% include sidebar.html %} + {% include sidebar.html %}

{{ page.title }}

{{ content }} -
-
diff --git a/docs/custom.css b/docs/custom.css index b2c5a386..043dfbc0 100644 --- a/docs/custom.css +++ b/docs/custom.css @@ -103,3 +103,17 @@ a { .code-tooltip { scroll-margin-top: 150px; } + + +/* Prev and next links */ +.prev-next-links { + display: flex; + gap: 16px; +} + +.prev-next-links__button { + border: solid 1px; + padding: 16px; + border-radius: 4px; + flex: 1; +} \ No newline at end of file From 8b4a45c9bf80906f99ee24b398d86d5b05ef3610 Mon Sep 17 00:00:00 2001 From: Robin Marillia Date: Mon, 15 Aug 2022 19:26:51 +0200 Subject: [PATCH 05/37] revert the lock file to main --- docs/Gemfile.lock | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock index 350cb83f..3b3e7f35 100644 --- a/docs/Gemfile.lock +++ b/docs/Gemfile.lock @@ -98,7 +98,6 @@ GEM faraday (> 0.8, < 2.0) PLATFORMS - universal-darwin-21 x86_64-linux DEPENDENCIES From d3f6e827be9a4dbb9ecee2f648e9609d737a1507 Mon Sep 17 00:00:00 2001 From: Robin Marillia Date: Tue, 16 Aug 2022 21:46:56 +0200 Subject: [PATCH 06/37] fix: add baseurl to prev and next links to fix the 404 error in production on github pages --- docs/Gemfile.lock | 1 + docs/_layouts/guide.html | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock index 3b3e7f35..350cb83f 100644 --- a/docs/Gemfile.lock +++ b/docs/Gemfile.lock @@ -98,6 +98,7 @@ GEM faraday (> 0.8, < 2.0) PLATFORMS + universal-darwin-21 x86_64-linux DEPENDENCIES diff --git a/docs/_layouts/guide.html b/docs/_layouts/guide.html index 45c1856d..eaf2ca9f 100644 --- a/docs/_layouts/guide.html +++ b/docs/_layouts/guide.html @@ -27,12 +27,12 @@

{{ page.title }}