Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions assets/scss/_styles_project.scss
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
@import 'td/extra';
@import 'td/extra/bs-defaults';

@import 'td/color-adjustments-dark';
@import 'td/code-dark';
@import 'td/gcs-search-dark';
59 changes: 38 additions & 21 deletions content/en/_index.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,59 @@
---
title: Docsy starter
description: A website starter for technical documentation
description: A Docsy-themed website template for technical documentation
outputs:
- HTML
- REDIRECTS # Include this `content/en` ONLY
developer_note:
The blocks/cover shortcode (used below) will use as a background image any
image file containing "background" in its name.
show_banner: true
params:
body_class: td-navbar-links-all-active
show_banner: true
---

{{% blocks/cover title="Docsy Starter" image_anchor="top" height="full" %}}
{{% blocks/cover
title="Welcome to Docsy Starter!"
height="full td-below-navbar"
%}}

<!-- prettier-ignore -->
{{% param description %}}
{.display-6}

<a class="btn btn-lg btn-primary me-3" href="docs/">Learn More</a>
<a class="btn btn-lg btn-secondary" href="docs/get-started/">Get started</a>
{.p-initial .my-5}

{{% blocks/link-down color="info" %}} {{% /blocks/cover %}}

{{% blocks/lead color="primary" %}}

Docsy is a theme for the Hugo static site generator that's specifically designed
for technical documentation sets. Our aim is to help you get a working
<!-- prettier-ignore -->
<div class="td-cta-buttons my-5">
<a {{% _param btn-lg primary %}} href="docs/">
Learn more
</a>
<a {{% _param btn-lg secondary %}}
href="{{% param github_repo %}}"
target="_blank" rel="noopener noreferrer">
Get the template
{{% _param FA brands github "" %}}
</a>
</div>

{{% blocks/link-down color="info" %}}

{{% /blocks/cover %}}

{{% blocks/lead color="white" %}}

Docsy is a theme for the [Hugo][] static site generator that's specifically
designed for technical documentation sets. Our aim is to help you get a working
documentation site up and running as easily as possible, so you can concentrate
on creating great content for your users.

<a href="https://www.netlify.com" target="_blank" rel="noopener">
<img src="https://www.netlify.com/img/global/badges/netlify-color-accent.svg" alt="Deploys by Netlify" />
</a>
[![Deploys by Netlify][netlify-badge]][netlify]

[Hugo]: https://gohugo.io/
[netlify]: https://www.netlify.com/
[netlify-badge]:
https://www.netlify.com/img/global/badges/netlify-color-accent.svg

{{% /blocks/lead %}}

{{% blocks/section color="dark" type="row" %}}
{{% blocks/section color="dark bg-gradient" type="row" %}}

{{% blocks/feature icon="fa-lightbulb" title="See Docsy in action!" url="/docs/examples/" %}}
{{% blocks/feature icon="fa-lightbulb" title="See Docsy in action!" url="docs/examples/" %}}

As well as our example site, there's a growing number of projects using Docsy
for their doc sites.
Expand Down
Binary file added content/en/background-pexels-therato-3472764.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions content/en/blog/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,5 @@
title: Blog
menu: { main: { weight: 50 } }
---

{{% _param "pagePlaceholderNoteBody" %}}
7 changes: 1 addition & 6 deletions content/en/docs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,4 @@ linkTitle: Docs
menu: { main: { weight: 20 } }
---

This is placeholder content. Replace it with your own content. Use this section
to guide readers through your product or project. Start with quickstart steps,
link to core concepts, and point to reference material for advanced use cases.
Keep each page focused, practical, and easy to scan so new users can find
answers quickly while experienced users can dive deeper when they need
specifics.
{{% _param "pagePlaceholderNoteBody" %}}
Binary file removed content/en/featured-background.jpg
Binary file not shown.
11 changes: 11 additions & 0 deletions hugo.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ params:
Project Authors | [CC BY 4.0](https://creativecommons.org/licenses/by/4.0)
|
from_year: 2024
to_year: present
github_repo: https://github.com/chalin/docsy-starter
gcs_engine_id: b11e9c44d8d004464 # CUSTOMIZE - this is the starter ID
privacy_policy: https://www.linuxfoundation.org/legal/privacy-policy
Expand All @@ -88,6 +89,16 @@ params:
Sorry to hear that. Please <a
href="https://github.com/google/docsy/issues/new">tell us how we can
improve</a>.
pagePlaceholderNoteBody: |
**This is placeholder content**. Replace it with your own content. To learn
more, see [Get started][] from the [Docsy][] User Guide.

[Docsy]: https://docsy.dev
[Get started]: https://docsy.dev/docs/get-started/
# Text macros: use with _param
btn-lg: class="btn btn-lg btn-{1}" role="button"
FA: <i class="fa-{1} fa-{2} text-{3} px-1"></i>

links: # CUSTOMIZE
user:
- name: User mailing list
Expand Down
15 changes: 9 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
"_check:links": "make --keep-going check-links",
"_commit:public": "HASH=$(git rev-parse --short main); cd public && git add -A && git commit -m \"Site at $HASH\"",
"_diff:check": "git diff --name-only --exit-code",
"_ensure:docsy-hugo-modules": "test -d node_modules/github.com || npm --prefix node_modules/docsy run postinstall",
"_filename-error": "echo 'ERROR: the following files violate naming conventions; fix using: `npm run fix:filenames`'; echo; npm run -s _ls-bad-filenames; exit 1",
"_filenames-to-kebab-case": "find assets content -name '*_*' ! -name '[_.]*' -exec sh -c 'mv \"$1\" \"${1//_/-}\"' _ {} \\;",
"_hugo-dev": "npm run _hugo -- -e dev -DFE",
Expand All @@ -30,19 +29,23 @@
"make:public": "git init public",
"postbuild:preview": "npm run _check:links--warn",
"postbuild:production": "npm run _check:links--warn",
"postinstall": "test ! -d node_modules/docsy || npm run _ensure:docsy-hugo-modules",
"postinstall": "npm --prefix node_modules/docsy run postinstall",
"precheck:links:all": "npm run build",
"precheck:links": "npm run build",
"random:text": "node scripts/random-text.js",
"seq": "bash -c 'for cmd in \"$@\"; do npm run $cmd || exit 1; done' - ",
"serve": "npm run _serve",
"test": "npm run check:format && npm run check:links",
"test": "npm list docsy && npm run check:format && npm run check:links",
"update:docsy:local": "npm install -D file:../docsy/docsy && npm list docsy",
"update:docsy:main": "npm install -D google/docsy#main && npm list docsy",
"update:hugo": "npm install --save-exact -D hugo-extended@latest",
"update:packages": "npx npm-check-updates --dep 'prod,dev,optional,peer' -u"
},
"devDependencies": {
"autoprefixer": "^10.4.21",
"cspell": "^9.0.2",
"docsy": "google/docsy#semver:0.13.0",
"hugo-extended": "^0.152.2",
"docsy": "github:google/docsy#main",
"hugo-extended": "0.155.3",
"postcss-cli": "^11.0.1",
"prettier": "^3.5.3"
},
Expand All @@ -54,7 +57,7 @@
"engines": {
"node": ">=24"
},
"gitHubActionCacheKey": "2026-02-06 - refresh cache for Docsy 0.13.0 and Hugo 0.152.2",
"gitHubActionCacheKey": "2026-02-09 - refresh cache for Docsy and latest hugo-extended",
"private": true,
"prettier": {
"proseWrap": "always",
Expand Down
16 changes: 16 additions & 0 deletions static/refcache.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@
"StatusCode": 206,
"LastSeen": "2026-02-06T17:17:03.380923-05:00"
},
"https://docsy.dev": {
"StatusCode": 206,
"LastSeen": "2026-02-09T14:45:58.320155-05:00"
},
"https://docsy.dev/docs/get-started/": {
"StatusCode": 206,
"LastSeen": "2026-02-09T14:45:58.167499-05:00"
},
"https://git-scm.com/book/en/v2/Git-Tools-Submodules": {
"StatusCode": 206,
"LastSeen": "2026-02-06T17:17:04.955354-05:00"
Expand Down Expand Up @@ -75,6 +83,10 @@
"StatusCode": 206,
"LastSeen": "2026-02-06T17:17:04.060212-05:00"
},
"https://gohugo.io/": {
"StatusCode": 206,
"LastSeen": "2026-02-09T05:09:16.548751-05:00"
},
"https://gohugo.io/hugo-modules/": {
"StatusCode": 206,
"LastSeen": "2026-02-06T17:17:04.172438-05:00"
Expand Down Expand Up @@ -103,6 +115,10 @@
"StatusCode": 206,
"LastSeen": "2026-02-06T17:17:03.156405-05:00"
},
"https://www.netlify.com/": {
"StatusCode": 206,
"LastSeen": "2026-02-09T05:09:16.606996-05:00"
},
"https://www.netlify.com/img/global/badges/netlify-color-accent.svg": {
"StatusCode": 206,
"LastSeen": "2026-02-06T17:17:03.318545-05:00"
Expand Down