Commit Graph

14 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 1dc711d3b5
shortcode to have checkmark emoji use the body font color (#714)
* shortcode to have checkmark emoji use the body font color

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

* Replace ✔️  text with check shortcode to have color respond to color mode

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

---------

Signed-off-by: Pete Lumbis <pete@upbound.io>
2024-02-20 07:09:26 -05: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
Pete Lumbis 5c360ba900
Changes for API support (#642) 2023-12-01 15:11:06 -05:00
Pete Lumbis b7d4ff93f4
fix expand box bottom corners on expand
Signed-off-by: Pete Lumbis <pete@upbound.io>
2023-08-08 15:59:17 -04:00
Pete Lumbis 2583a00224
Update Composition Docs (#475) 2023-07-26 14:26:23 -04:00
Pete Lumbis d7c9eb65f0
Update editCode marker to
Signed-off-by: Pete Lumbis <pete@upbound.io>
2023-06-20 11:29:39 -04:00
Pete Lumbis fc8125cf30
Script to clear or reset span contents for editable elements (#374) 2023-03-07 10:49:07 -05:00
Pete Lumbis 32e3bfc64b
Enable optional line/field editing in code examples (#311) 2023-02-02 09:39:13 -05:00
Pete Lumbis 85407e88c6
Docs Reorg for v1.11 (#271)
Reorg and new home page for docs.
2023-01-31 18:59:52 -05:00
Pete Lumbis 247efca59c
Use Hugo anchorize to sanitize titles. Resolves #301 (#302)
Signed-off-by: Pete Lumbis <pete@upbound.io>
2023-01-30 11:49:04 -05:00
Pete Lumbis 23164929f2
move content media to top level folder (#265)
Signed-off-by: Pete Lumbis <pete@upbound.io>

Signed-off-by: Pete Lumbis <pete@upbound.io>
2023-01-12 21:57:48 -05:00
Pete Lumbis 6bc295c31a
Support styling for bootstrap tables (#249)
Signed-off-by: Pete Lumbis <pete@upbound.io>

Signed-off-by: Pete Lumbis <pete@upbound.io>
2023-01-03 11:32:13 -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