Commit Graph

22 Commits

Author SHA1 Message Date
Pete Lumbis e2603a9cc0
API Docs Backend Refactor (#757)
Refactor API rendering to be modular.

Signed-off-by: Pete Lumbis <pete@upbound.io>
2024-04-22 14:51:46 -04:00
Pete Lumbis 7226eac3fc
Fix table colors in dark mode (#700)
* Add borders to tables

Signed-off-by: Pete Lumbis <pete@upbound.io>

* margins and padding around tables

Signed-off-by: Pete Lumbis <pete@upbound.io>

* Fix table mode coloring. Resolves #690

Signed-off-by: Pete Lumbis <pete@upbound.io>

* table styling fixes

Signed-off-by: Pete Lumbis <pete@upbound.io>

---------

Signed-off-by: Pete Lumbis <pete@upbound.io>
2024-02-06 09:15:01 -10:00
Sharp d0e12d0952
Dark Mode Table Legibility (#668)
* attempt at table update

Signed-off-by: Rachel Sharp <8883519+tr0njavolta@users.noreply.github.com>

* alignment

Signed-off-by: Rachel Sharp <8883519+tr0njavolta@users.noreply.github.com>

---------

Signed-off-by: Rachel Sharp <8883519+tr0njavolta@users.noreply.github.com>
2024-01-04 16:31:48 -05:00
Pete Lumbis 5c360ba900
Changes for API support (#642) 2023-12-01 15:11:06 -05:00
Pete Lumbis 6feb7ce6fc
add RSS support for release notes. Resolves #629 (#638) 2023-12-01 12:11:39 -05:00
Shane Miller a12284a466
Minor color improvements (#522) 2023-08-08 15:57:15 -04:00
Lovro Sviben 7ac4dc6c82
update management policies with GMP changes (#510)
Co-authored-by: Hasan Turken <turkenh@gmail.com>
2023-08-07 13:02:22 -04:00
Shane Miller b134e9fe71 tabs design
Signed-off-by: Shane Miller <shanecm.ux@gmail.com>
2023-08-04 10:55:20 -07:00
Shane Miller f81f1b0d5b adjust table colors
Signed-off-by: Shane Miller <shanecm.ux@gmail.com>
2023-08-04 10:29:24 -07:00
Shane Miller 35a0da5237 Improve H1 Spacing and Improve Tables
Signed-off-by: Shane Miller <shanecm.ux@gmail.com>
2023-08-04 10:23:41 -07:00
Shane Miller 8422cccb14 improve typography, spacing, and accordions
Signed-off-by: Shane Miller <shanecm.ux@gmail.com>
2023-08-04 08:51:48 -07:00
Shane Miller 69fb052907 Contrast improvements
Signed-off-by: Shane Miller <shanecm.ux@gmail.com>
2023-08-03 12:31:23 -07:00
Shane Miller 5a959cbfeb update contrast for code snippets
Signed-off-by: Shane Miller <shanecm.ux@gmail.com>
2023-08-03 12:31:23 -07:00
Shane Miller e2ec19a9f6 update contrast for code snippets
Signed-off-by: Shane Miller <shanecm.ux@gmail.com>
2023-08-03 12:31:23 -07:00
Shane Miller 461873082a fix code backgrounds to work on hints/tips
Signed-off-by: Shane Miller <shanecm.ux@gmail.com>
2023-08-03 12:31:23 -07:00
Shane Miller 342c77cb2f increase contrast of hint blocks in dark mode
Signed-off-by: Shane Miller <shanecm.ux@gmail.com>
2023-08-03 12:31:23 -07:00
Shane Miller d5916b7c1e style updates
Signed-off-by: Shane Miller <shanecm.ux@gmail.com>
2023-08-03 12:31:23 -07:00
Shane Miller 5e530319e8 add color variables, update code blocks, update dark theme items
Signed-off-by: Shane Miller <shanecm.ux@gmail.com>
2023-08-03 12:31:23 -07:00
Pete Lumbis c3c578916e
Fix dark mode stylings (#379) 2023-03-06 14:38:02 -05:00
Pete Lumbis a1f6f69bcb
Code copy (Take 2) (#237)
Adds a copy to clipboard button using Clipboard.js
Optional support for defining which lines to copy out of the code box.
Adds styling and anchor links to the line numbers
Adds support to link to line number anchors inside tabs
Removes line numbers from tables (no user impact, changes styling and JS element targeting)
Makes the top NAV not sticky. This is required to make the line number anchors work. Otherwise the line number linked to will go under the navbar and not be in view. Fixing this with a sticky nav is a very large lift (for me). Also note, the side bars are still sticky.
Removes clipboard scsss files. All clipboard related styles are merged into code-theme-base.scss
Also applies Hugo caching fixes that can cause the stylesheet not to load in local dev (discovered in this PR)
2022-12-16 09:23:53 -05:00
Pete Lumbis dd80b838c5
Adds Algolia DocSearch components and manual style overrides (#226)
* Adds Algolia DocSearch components and manual style overrides

Signed-off-by: Pete Lumbis <pete@upbound.io>

* Auto close menu on mobile when search box is clicked

Signed-off-by: Pete Lumbis <pete@upbound.io>

* Add search hotkey indicators

Signed-off-by: Pete Lumbis <pete@upbound.io>

Signed-off-by: Pete Lumbis <pete@upbound.io>
2022-12-09 13:20:25 -05:00
Pete Lumbis f1e0f4d865
Docs redesign (#210)
This completely redesigns the docs and moves them to a new domain docs.crossplane.io and hosting on Netlify. 

This creates a custom Hugo theme affectionally called `Geekboot` based the work of both [Geekdoc](https://geekdocs.de/) and [Bootstrap](https://github.com/twbs/bootstrap/tree/main/site).

[Lighthouse testing on desktop](https://pagespeed.web.dev/report?url=https%3A%2F%2Fdocs.crossplane.io%2Fv1.10%2F&form_factor=desktop) gives the site a 100/100 in performance and best practices, 90/100 in accessibility and 92/100 in SEO.

Besides new layout and colors other new user-facing features include:
* Dark mode
* Fully responsive design and mobile ready
* Automated webp image conversion and optimization as well as lazy loading
* Tabs 
* Alerts and hint boxes
* Foldable/hide long outputs
* Linkable anchors inside tabs
* Improved code boxes with line numbers 
* Adds support for docs.crossplane.io/latest
* Right hand page table of contents 
* Improved text readability 

Infrastructure improves:
* Uses [Bootstrap](https://getbootstrap.com/) to dramatically simplify styling and site development 
* Prefetch links on hover using [instant.page](https://instant.page/)
* Highly optimized CSS using PostCSS and [PurgeCSS ](https://purgecss.com/) without requiring users to install additional tools
* Minimizes the use of JavaScript and bundles scripts with [Webpack](https://webpack.js.org/) to optimize load times
* Massive improvement of SCSS/CSS organization and overrides improving the development process for stylesheet changes
* Optimizes existing SVGs and converts all other template images to webp
* Minification on production builds to further reduce page sizes

This also bumps the `Makefile` Hugo version to [0.107.0](https://github.com/gohugoio/hugo/releases/tag/v0.107.0) to pick up build improvements related to code syntax highlighting, improving builds about about 20-30% in unscientific testing.
2022-12-01 11:11:29 -05:00