github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2025-02-24 01:52:28 +00:00
Code Issues Projects Releases Packages Wiki Activity
hugo/docs/content/en/showcase/1password-support/index.md

40 lines
3.6 KiB
Markdown
Raw Normal View History

Squashed 'docs/' content from commit fdea5430f git-subtree-dir: docs git-subtree-split: fdea5430f89dfd849d39212abdf5ace0a4763e5a
2019-10-21 08:22:28 +00:00
---
title: 1Password Support
date: 2018-02-22
description: "Showcase: \"Compiles 400 pages in five languages in the blink of an eye.\""
siteURL: https://support.1password.com/
byline: "[Mitch Cohen](https://github.com/mitchchn), Documentation Team Lead"
aliases: [/showcase/1password/]
---
At 1Password, we used to go through a different documentation platform every month: blog engines, ebooks, wikis, site generators written in Ruby and JavaScript. Each was inadequate in its own special way. Then we found **Hugo**. We made one last switch, and we're glad we did.
### Not all static site generators are created equal
Finding a tool that will make your customers, writers, designers, _and_ DevOps team happy is no easy task, but we managed it with Hugo:
**Hugo is static**. We're a security company, so we swear by static sites and use them wherever possible. We feel much safer pointing customers at HTML files than at a complicated server which needs to be hardened.
**Hugo is Go**. We love the Go programming language at 1Password, and we were delighted to learn that Hugo used the same Go template syntax that our designers and front-end developers had already mastered.
Squashed 'docs/' changes from 9be494de3..ac2c4a487 ac2c4a487 Update documentation for Ugly URLs (#1082) 88bdec17a Change 072.0 to 0.72.0 in release post's description 2aa7d7818 Update rss.md (#1104) c80677aeb Update quick-start.md (#1076) d04196bbd Minor spelling and capitalization fixes 837d2feba Fixed spelling mistake 67dc78e12 Update installing.md ce280c5d6 Update relurl.md bb4d0e703 Capitalization and Redirecting URL fixes e1fecada0 Update partials.md 1d99bb182 Typos and whitespacing issues fixed b20dba125 actually fix index function link this time f47d6f1e3 Fixing typos, whitespace issues and links dc82309b9 fix link to the index function 1eab0cbea add missing word (#1130) 9c3ee62ae more fixes e9bc5880a whitespace, typos and HTTPS fixes 93b806493 Add missing word to Module section 80ced9062 Display image on page bundles page. 727029b0a Update index.md 51fc48e4d Release 0.72.0 1ff68ac3b releaser: Add release notes to /docs for release of 0.72.0 f74a25b92 common/maps: Add Scratch.Values 2fd83db96 Add redirect support to the server bdfccf9f4 Fix typo in install instructions e12737ea6 Create SUPPORT.md git-subtree-dir: docs git-subtree-split: ac2c4a4871e90ddfb180f23704ce7ec9023529ca
2020-06-16 12:18:51 +00:00
Squashed 'docs/' content from commit fdea5430f git-subtree-dir: docs git-subtree-split: fdea5430f89dfd849d39212abdf5ace0a4763e5a
2019-10-21 08:22:28 +00:00
**Hugo is FAST**. Our previous static site generator took nearly a minute to compile our (then much smaller) site. Developers might be used to this, but it wasn't cutting it for writers who wanted to see live previews of their work. Hugo did the same job in milliseconds, and to this day compiles 400 pages in five languages in the blink of an eye.
**Hugo is flexible**. Thanks to Hugo's content and layout system, we were able to preserve our existing file and folder structure and port our entire production site in a few days. We could then create new content types that weren't possible before, like these snazzy [showcases](https://support.1password.com/explore/extension/).
**Hugo is great for writers**. Our documentation team was already comfortable with Markdown and Git and could start creating content for Hugo with zero downtime. Once we added shortcodes, our writers were able to dress up articles with features like [platform boxes](https://support.1password.com/get-the-apps/) with just a bit of new syntax.
**Hugo has an amazing developer community**. Hugo updates are frequent and filled to the brim with features and fixes. As we developed the multilingual version of our site, we submitted PRs for features we needed and were helped through the process by [@bep](https://github.com/bep) and others.
**Hugo is simple to deploy**. Hugo has just the right amount of configuration options to fit into our build system without being too complicated.
### Tech specs
* [1Password Support](https://support.1password.com) uses Hugo with a custom theme. It shares styles and some template code with [1Password.com](https://1password.com), which we also moved to Hugo in 2016.
* Code and articles live in a private GitHub repository, which is deployed to a static content server using Git hooks.
* Writers build and preview the site on their computers and contribute content using pull requests.
Squashed 'docs/' changes from 4d936aee6..4dd2d6415 4dd2d6415 Fix erroridf example 9ae8e9199 Clarify highlight options f3943f9c8 Fix typo b57ea5ac8 Add field to glossary of terms 3191e35b4 Clarify comment in the new-in shortcode 870c8d35c Correct description of Ref and RelRef page methods c9df50e6e Specify encoding in description of crypto functions 749bb37e2 Add Ref, RelRef, and Site shortcode methods 994d4374b Update fmt functions 740f5ef96 Misc additions 77acdcdb6 Remove rssLimit from root config documentation df84a1795 Document the openapi3.Unmarshal function 24236f57d Miscellaneous edits and corrections 41b54d421 Hide the "new in" button after some period of time 3c1ebac31 Update Ancestors.md e699eb313 Add new-in tags to select functions and methods 5c41f0bf8 Clarify time.Format method f7bd43ae1 Add link to built-in render hook for GoAT diagrams 06f9cd4c9 Document the diagrams.Goat function 5e432e12d Adjust quick reference weights fc915efd6 Update FAQ 5bccf8b19 Use LinkTitle consistently in examples 36f207f3a Add page collection quick reference 699de883d Inlcude example of newScratch.Values 9bb7f8c78 Include RenderString example for emoji shortcodes 783fdd3ac Fix typo 26d5a4399 Fix typo c7e86f0cf Fix typo ad2a82fbd Clarify data type returned by partial and partialCached 1de5a52dd Miscellaneous corrections 3509e1b4d Update configuration-markup.md 8c6a9bf02 Clairfy figure shortcode output c9d0dc8fb Update Markdownify.md 0c4bc1447 Update theme 0f0ab2ade Add methods deprecated in v0.120.0 e1c6ecd0f Miscellaneous edits ec53b55b9 netlify: Hugo 0.120.4 23a1f3fd5 templates/internal.md: Correct GoogleAnalytics key name 6dcfa9a82 Update troubleshooting section 0c8857e8f Adjust code and code-toggle shortcodes 8820264d3 Reduce number of site audit warnings 526d06b90 Clarify hint option in image processing spec 310849daa Image Processing: Improve sentence and fix code sample 5bb67bfd4 Revert "Image Processing: Improve sentence and fix code sample" (#2318) 77c926fde Image Processing: Improve sentence and fix code sample 52179fb18 Miscellaneous edits f4e886715 Revert change to hugo.work c410fefa8 Update theme 8b72dfedd Rework where function documentation f35a7126f Minor edits to global page function 903b42ebc Cleanup shortcode calls c9247e98d Update documentation.md dff3c4abb Clean up build option descriptions and examples f46d31308 Use consistent signatures 2af2470b5 Minor correction to resources.GetRemote 45ec53fe0 Remove superfluous shortcode param 2a0544757 Improve deployment documentation 3cf36a7fc Clarify lang keyword f10d6495d Update front-matter.md dc94e20be Add Sveltia to CMS list b15d6d670 Update front-ends.md bb41588b2 Update FormatCurrency.md b40fff396 Add showcase for hidden sections without index.html 71316e181 Improve image filter examples d46f0b1d8 Miscellaneous edits ad3f9cdb6 Adjust quick reference guides 8657804ba Update theme d9e981147 Miscellaneous corrections 508666575 Miscellaneous updates 80b2241f9 Miscellaneous updates 723a827fd Namespace functions and methods 40212779a netlify: Hugo 0.120.3 66017c704 Bump GitHub workflows to latest versions db0f1e682 Update related.md 7e758c23b netlify: Hugo 0.120.2 641ba3976 Update configuration.md d2a9909d9 Update rss.md 7eb59d7a2 netlify: Hugo 0.120.1 708c351c4 Document debug.Timer 28e2388c2 Add new-in tag to images.Padding ee24cffb5 Add new-in tags to hugo.IsDevelopment and hugo.IsServer aa47ca023 netlify: Hugo 0.120.0 9c3e606fc docs: Regen docshelper 159fd971e commands/new: Remove format flag from new content cmd 9f7878092 Merge commit 'aaaf1c8df5d6aa061609d20510f7fa6c42e5cc1a' 65b2dd324 docs: Regenerate docshelper 2be620663 resources/images: Create padding image filter c777d6c5e Merge commit '3710a5ec7efe6baca6e452f43632c05d22bab3c4' 24f2afeb2 Merge commit 'e509cac533600cf4fa8382c9cdab78ddd82db688' 3f947c19a hugolib: Deprecate .Site.DisqusShortname 6bd1af892 hugolib: Deprecate .Site.GoogleAnalytics 78becc6ee tpl/tplimpl: Deprecate .Site.Social usage with internal templates e3ec2a4f2 common/hugo: Add hugo.IsServer and hugo.IsDevelopment git-subtree-dir: docs git-subtree-split: 4dd2d641531f74025ed9f51ea5a961e936988cfb
2023-12-04 14:14:18 +00:00
* We use Hugo's [multilingual support](/content-management/multilingual/) to build the site in English, Spanish, French, Italian, German, and Russian. With the help of Hugo, 1Password Support became our very first site in multiple languages.
Squashed 'docs/' content from commit fdea5430f git-subtree-dir: docs git-subtree-split: fdea5430f89dfd849d39212abdf5ace0a4763e5a
2019-10-21 08:22:28 +00:00
* Our [contact form](https://support.1password.com/contact) is a single-page React app. We were able to integrate it with Hugo seamlessly thanks to its support for static files.
* The one part of the support site which is not static is our search engine, which we developed with Elasticsearch and host on AWS.
Reference in a new issue Copy permalink