Commit Graph

6 Commits

Author SHA1 Message Date
Pete Lumbis fc8125cf30
Script to clear or reset span contents for editable elements (#374) 2023-03-07 10:49:07 -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 b191ce133d
Adds missing script import for search and sets docs param (#269)
Signed-off-by: Pete Lumbis <pete@upbound.io>

Signed-off-by: Pete Lumbis <pete@upbound.io>
2023-01-12 22:36:08 -05:00
Pete Lumbis 40ea0ed110
Moves the search box JS from end of page to search div (#259)
Signed-off-by: Pete Lumbis <pete@upbound.io>

Signed-off-by: Pete Lumbis <pete@upbound.io>
2023-01-12 21:53:57 -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