Examples and templates

Get started with a template or explore some Docsy-based sites

One of the best ways to see what Docsy can do, and learn how to configure a site with it, is to see some real projects. Of course, we use Docsy for this site. For the site source, see docsy.dev.

Goldydocs starter template homepage

The main Docsy example site starter template.

Docsy starter template homepage

An opinionated starter including CI/CD setup.

Starter templates

The Docsy project provides two site starter templates:

SiteRepoDocsy
Goldydocs - main Docsy examplehttps://github.com/google/docsy-examplev0.14.0 (latest)
Docsy starterhttps://github.com/chalin/docsy-starterv0.14.0 (latest)

In addition to these example starters, there are several live sites using the theme. Consider adding your Docsy-based site to this page once you have a production site up and running.

Thumbnails for the starter templates are shown above. Both use a hero image. For an example of a cover that is a gradient of the primary theme color, see this test Homepage.

Docsy theme examples

Example sites that have low to no customization:

SiteRepo
docsy.dev (this site)https://github.com/google/docsy/tree/main/docsy.dev
AgileBase docshttps://github.com/okohll/abdocs
Agones.devhttps://github.com/googleforgames/agones/tree/main/site
Apache Parquethttps://parquet.apache.org
CloudWeGo.iohttps://github.com/cloudwego/cloudwego.github.io
etcd.iohttps://github.com/etcd-io/website
fission.iohttps://github.com/fission/fission.io
fluxcd.iohttps://github.com/fluxcd/website
Graphvizhttps://gitlab.com/graphviz/graphviz.gitlab.io
gRPChttps://github.com/grpc/grpc.io
JVMPerf.nethttps://github.com/cchesser/java-perf-workshop
Kubeflow.orghttps://github.com/kubeflow/website
Layer5 Docshttps://github.com/layer5io/docs
Navidrome Music Serverhttps://github.com/navidrome/website
OpenTelemetry.iohttps://github.com/open-telemetry/opentelemetry.io
protobuf.devhttps://github.com/protocolbuffers/protocolbuffers.github.io
Selenium.devhttps://github.com/SeleniumHQ/seleniumhq.github.io
Stroom.iohttps://github.com/gchq/stroom-docs
tekton.devhttps://github.com/tektoncd
YMCA Website Serviceshttps://github.com/YCloudYUSA/yusaopeny_docs

Customized Docsy examples

Example sites that include a moderate to high amount of customization:

SiteRepo
Apache Airflowhttps://github.com/apache/airflow-site/
Docsy Mostly Docshttps://github.com/gwatts/mostlydocs/
Kuberneteshttps://github.com/kubernetes/website
XLThttps://github.com/Xceptance/xlt-documentation
Daprhttps://github.com/dapr/docs