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
4 changes: 2 additions & 2 deletions content/en/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,10 +61,10 @@ Please follow this space for updates!

{{% blocks/feature
title="Contributions welcome!" icon="fab fa-github"
url="https://github.com/google/docsy-example"
url="https://github.com/docsy/docsy-example"
%}}

We do a [Pull Request](https://github.com/google/docsy-example/pulls)
We do a [Pull Request](https://github.com/docsy/docsy-example/pulls)
contributions workflow on **GitHub**. New users are always welcome!

{{% /blocks/feature %}}
Expand Down
2 changes: 1 addition & 1 deletion content/en/about/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ menu: { main: { weight: 10 } }

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

Goldydocs is a sample site using the [Docsy](https://github.com/google/docsy)
Goldydocs is a sample site using the [Docsy](https://github.com/docsy/docsy)
Hugo theme that shows what it can do and provides you with a template site
structure. It’s designed for you to clone and edit as much as you like. See the
different sections of the documentation and site for more ideas.
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ For large documentation sets we recommend adding content under the headings in
this section, though if some or all of them don’t apply to your project feel
free to remove them or add your own. For a smaller example, see the
[Docsy User Guide](https://docsy.dev/docs/), built from the
[`docsy.dev`](https://github.com/google/docsy/tree/main/docsy.dev) directory of
[`docsy.dev`](https://github.com/docsy/docsy/tree/main/docsy.dev) directory of
the Docsy monorepo.

Other content such as marketing material, case studies, and community updates
Expand Down
12 changes: 6 additions & 6 deletions content/en/docs/contribution-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ the README, or include them in both locations.
{{% /pageinfo %}}

We use [Hugo](https://gohugo.io/) to format and generate our website, the
[Docsy](https://github.com/google/docsy) theme for styling and site structure,
[Docsy](https://github.com/docsy/docsy) theme for styling and site structure,
and [Netlify](https://www.netlify.com/) to manage the deployment of the site.
Hugo is an open-source static site generator that provides us with templates,
content organisation in a standard directory structure, and a website generation
Expand All @@ -41,7 +41,7 @@ Here's a quick guide to updating the docs. It assumes you're familiar with the
GitHub workflow and you're happy to use the automated preview of your doc
updates:

1. Fork the [Goldydocs repo](https://github.com/google/docsy-example) on GitHub.
1. Fork the [Goldydocs repo](https://github.com/docsy/docsy-example) on GitHub.
1. Make your changes and send a pull request (PR).
1. If you're not yet ready for a review, add "WIP" to the PR name to indicate
it's a work in progress. (**Don't** add the Hugo property "draft = true" to
Expand Down Expand Up @@ -78,11 +78,11 @@ work:
install Hugo and any other tools you need. You'll need at least **Hugo
version 0.146.0** (we recommend using the most recent available version), and
it must be the **extended** version, which supports SCSS.
1. Fork the [Goldydocs repo](https://github.com/google/docsy-example) repo into
your own project, then create a local copy using `git clone`.
1. Fork the [Goldydocs repo](https://github.com/docsy/docsy-example) into your
own project, then create a local copy using `git clone`.

```sh
git clone --branch v0.12.0 --depth 1 https://github.com/google/docsy-example.git
git clone --branch v0.12.0 --depth 1 https://github.com/docsy/docsy-example.git
```

1. Run `hugo server` in the site root directory. By default your site will be
Expand All @@ -96,7 +96,7 @@ work:

If you've found a problem in the docs, but you're not sure how to fix it
yourself, please create an issue in the
[Goldydocs repo](https://github.com/google/docsy-example/issues). You can also
[Goldydocs repo](https://github.com/docsy/docsy-example/issues). You can also
create an issue about a specific page by clicking the **Create Issue** button in
the top right hand corner of the page.

Expand Down
4 changes: 2 additions & 2 deletions content/en/site.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Website information
likeTitle: Site info
linkTitle: Site info
description: Information about the website.
type: docs
params:
Expand All @@ -16,4 +16,4 @@ v{{% param version %}} </span>][version]

{{% td/site-build-info/netlify team="docsy-example" %}}

[version]: <https://github.com/google/docsy/releases/v{{% param version %}}>
[version]: <https://github.com/docsy/docsy/releases/v{{% param version %}}>
4 changes: 2 additions & 2 deletions content/fa/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,10 @@ description: ارزیابی درجه حرارت فرنی &mdash; در فضای

{{% blocks/feature
title="همکاری" icon="fab fa-github"
url="https://github.com/google/docsy-example"
url="https://github.com/docsy/docsy-example"
%}}

ما یک فرآیند [پول ریکوئست](https://github.com/google/docsy-example/pulls) در **گیتهاب** داریم. ما همیشه از همکاران جدید
ما یک فرآیند [پول ریکوئست](https://github.com/docsy/docsy-example/pulls) در **گیتهاب** داریم. ما همیشه از همکاران جدید
خوشحال می‌شویم.

{{% /blocks/feature %}}
Expand Down
2 changes: 1 addition & 1 deletion content/fa/about/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ menu: {main: {weight: 10}}

{{% blocks/lead %}}

اسناد گلدی یک نمونه سایت با استفاده از [پوسته‌ی داکسی](https://github.com/google/docsy) و قدرت گرفته از هوگو
اسناد گلدی یک نمونه سایت با استفاده از [پوسته‌ی داکسی](https://github.com/docsy/docsy) و قدرت گرفته از هوگو
است که به شما نشان می‌دهد چه ویژگی هایی دارد و یک ساختار کامل برای شما ایجاد کرده است.
این سایت برای شما ایجاد شده است که دریافت کنید و هرچقد که می‌خواهید آن را تغییر دهید. برای گرفتن ایده های بیشتر
می‌توانید از قسمت های مختلف سایت دیدن کنید.
Expand Down
2 changes: 1 addition & 1 deletion content/fa/docs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@ menu:

این قسمت مجلی است که مستندات کاربران در آن قرار دارد. همه‌ی اطلاعاتی که کاربران شما نیاز به فهمیدن دارند تا به درستی از پروژه شما استفاده کنند.

برای مستندات بزرگتر ما پیشنهاد می‌کنیم مطالب را طبق این مثال قرار دهید. البته ممکن است بعضی از آنها مورد نیاز نباشد. پس در حذف و اضافه کردن مطالب خود راحت باشید. نمونه کوچکتر مستندات داکسی را می‌توانید در [اینجا](https://docsy.dev/docs/) مشاهده کنید که در [مخزن گیتهاب پوسته داکسی](https://github.com/google/docsy/tree/main/docsy.dev) قرار دارد.
برای مستندات بزرگتر ما پیشنهاد می‌کنیم مطالب را طبق این مثال قرار دهید. البته ممکن است بعضی از آنها مورد نیاز نباشد. پس در حذف و اضافه کردن مطالب خود راحت باشید. نمونه کوچکتر مستندات داکسی را می‌توانید در [اینجا](https://docsy.dev/docs/) مشاهده کنید که در [مخزن گیتهاب پوسته داکسی](https://github.com/docsy/docsy/tree/main/docsy.dev) قرار دارد.

برای فهمیدن چگونگی استفاده از پوسته داکسی، از [رهنمود‌های پوسته داکسی](https://docsy.dev/docs/) استفاده کنید. همچنین می‌توانید در باره‌ی چگونگی مرتب کردن مستندات خود در [اینجا](https://docsy.dev/docs/best-practices/organizing-content/) بخوانید.
4 changes: 2 additions & 2 deletions content/no/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,11 +53,11 @@ Følg med her for oppdateringer!

{{% blocks/feature
title="Bidrag er velkomne!" icon="fab fa-github"
url="https://github.com/google/docsy-example"
url="https://github.com/docsy/docsy-example"
%}}

Vi bruker
[Pull Request](https://github.com/google/docsy-example/pulls)-arbeidsflyt på
[Pull Request](https://github.com/docsy/docsy-example/pulls)-arbeidsflyt på
**GitHub**. Nye brukere er alltid velkomne!

{{% /blocks/feature %}}
Expand Down
6 changes: 4 additions & 2 deletions go.mod
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
module github.com/google/docsy-example
module github.com/docsy/docsy-example

go 1.12

require github.com/google/docsy/theme v0.17.1-0.20260831231032-2c44726e7773 // indirect
require (
github.com/docsy/docsy/theme v0.17.1-0.20261006200131-644114223aa8 // indirect
)
4 changes: 2 additions & 2 deletions go.sum
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
github.com/google/docsy/theme v0.17.1-0.20260831231032-2c44726e7773 h1:hEh0qXu/KXXh7hobVkqh4jTZUnwh/PbI7FHhqPfS+9U=
github.com/google/docsy/theme v0.17.1-0.20260831231032-2c44726e7773/go.mod h1:NX/JqXCbZBn9Q2Hj7ez9Xeh9z4XcLiwmDYZXhB4RhRM=
github.com/docsy/docsy/theme v0.17.1-0.20261006200131-644114223aa8 h1:mi7ip5ZHhGFwamoSY/l1w7SqnZbJqUUe8taRohVm8VU=
github.com/docsy/docsy/theme v0.17.1-0.20261006200131-644114223aa8/go.mod h1:9SfRupN4s/a/PKbXmDHXYo9L+CQI+sokXbXuOxUR91E=
28 changes: 16 additions & 12 deletions hugo.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ enableRobotsTXT: true
# Will give values to .Lastmod etc.
enableGitInfo: true

# Comment out to disable taxonomies in Docsy
# Uncomment to disable taxonomies in Docsy
# disableKinds: [taxonomy]

# You can add your own taxonomies
Expand Down Expand Up @@ -93,12 +93,16 @@ markup:
# Uncomment if you want your chosen highlight style used for code blocks without a specified language
# guessSyntax: true

# Everything below this are Site Params

# Comment out if you don't want the "print entire section" link enabled.
# Output formats per page kind, beyond HTML. Remove `print` to drop the "print
# entire section" link; `redirects` writes the Netlify `_redirects` file;
# `markdown` and `LLMS` are Docsy's agent support (Markdown page versions and a
# per-site llms.txt), see https://www.docsy.dev/docs/content/agent-support/.
outputs:
home: [HTML, print, RSS, redirects]
section: [HTML, print, RSS]
home: [HTML, print, RSS, redirects, markdown, LLMS]
page: [HTML, markdown]
section: [HTML, print, RSS, markdown]

# Everything below this are Site Params

params:
taxonomy:
Expand Down Expand Up @@ -131,16 +135,16 @@ params:
version: 0.17.1-dev

# Repository configuration (URLs for in-page links to opening issues and suggesting changes)
github_repo: https://github.com/google/docsy-example
github_repo: https://github.com/docsy/docsy-example

# An optional link to a related project repo. For example, the sibling repository where your product code lives.
github_project_repo: https://github.com/google/docsy
github_project_repo: https://github.com/docsy/docsy

# Specify a value here if your content directory is not in your repo's root directory
# github_subdir: ""

# Uncomment this if your GitHub repo does not have "main" as the default branch,
# or specify a new value if you want to reference another branch in your GitHub links
# Change this if your GitHub repo does not have "main" as the default branch,
# or if you want to reference another branch in your GitHub links
github_branch: main

# Google Custom Search Engine ID. Remove or comment out to disable search.
Expand Down Expand Up @@ -223,7 +227,7 @@ params:
icon: fa-solid fa-hammer
desc: Site build information.
- name: GitHub
url: https://github.com/google/docsy
url: https://github.com/docsy/docsy
icon: fab fa-github
desc: Development takes place here!
- name: Slack
Expand All @@ -248,5 +252,5 @@ module:
extended: true
min: 0.160.1
imports:
- path: github.com/google/docsy/theme
- path: github.com/docsy/docsy/theme
disable: false
25 changes: 25 additions & 0 deletions link-cache.jsonc
Original file line number Diff line number Diff line change
Expand Up @@ -349,6 +349,31 @@
"when": "2026-06-29T20:57:57Z",
"via": "lychee",
},
"https://github.com/docsy/docsy": {
"result": 200,
"when": "2026-10-06T23:08:57Z",
"via": "lychee",
},
"https://github.com/docsy/docsy-example": {
"result": 200,
"when": "2026-10-06T23:08:57Z",
"via": "lychee",
},
"https://github.com/docsy/docsy-example/issues": {
"result": 200,
"when": "2026-10-06T23:08:57Z",
"via": "lychee",
},
"https://github.com/docsy/docsy-example/pulls": {
"result": 200,
"when": "2026-10-06T23:08:57Z",
"via": "lychee",
},
"https://github.com/docsy/docsy/tree/main/docsy.dev": {
"result": 200,
"when": "2026-10-06T23:08:57Z",
"via": "lychee",
},
"https://github.com/google/docsy": {
"result": 200,
"when": "2026-06-29T20:57:56Z",
Expand Down
6 changes: 3 additions & 3 deletions lychee.toml
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ exclude = [
# Docsy page-meta links
'^https?://github\.com/.*?/.*?/(new|edit)/', # view/edit-source links
'^https://github\.com/[^/]+/[^/]+/issues/new', # per-page "create issue" feedback links
'^https://github\.com/google/docsy-example/commit/', # per-page provenance links
'^https://github\.com/google/docsy-example/tree/main/content/', # view-source tree links
'^https://github\.com/docsy/docsy-example/commit/', # per-page provenance links
'^https://github\.com/docsy/docsy-example/tree/main/content/', # view-source tree links

'^https://github\.com/google/docsy/releases/v[\d.]+-dev', # non-existent -dev releases
'^https://github\.com/docsy/docsy/releases/v[\d.]+-dev', # non-existent -dev releases
'^https://github\.com/USERNAME/REPOSITORY', # user guide placeholder repo
]
12 changes: 6 additions & 6 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

18 changes: 9 additions & 9 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
{
"name": "docsy-example-site",
"version": "0.17.1-dev+006-over-main-2c44726e",
"version": "0.17.1-dev+060-over-main-64411422",
"description": "Example site that uses Docsy theme for technical documentation.",
"repository": "github:google/docsy-example",
"repository": "github:docsy/docsy-example",
"homepage": "https://example.docsy.dev",
"author": "Docsy Authors",
"license": "Apache-2.0",
"bugs": "https://github.com/google/docsy-example/issues",
"bugs": "https://github.com/docsy/docsy-example/issues",
"spelling": "cSpell:ignore docsy hugo rtlcss -",
"workspaces": [
"packages/hugoautogen"
Expand All @@ -17,7 +17,7 @@
"_check:links": "lychee-norm-cache",
"_commit:public": "HASH=$(git rev-parse --short main); cd public && git add -A && git commit --allow-empty -m \"Site at $HASH\"",
"_diff:check": "git diff --name-only --exit-code",
"_get:docsy": "hugo mod get github.com/google/docsy/theme@v$npm_package_version",
"_get:docsy": "hugo mod get github.com/docsy/docsy/theme@v$npm_package_version",
"_hugo-dev": "npm run _hugo -- -e dev --logLevel info -DFE",
"_hugo": "hugo --cleanDestinationDir",
"_is:clean": "bash -c 'o=$(git status --porcelain -uall) && { echo \"$o\"; [ -z \"$o\" ]; }'",
Expand All @@ -28,7 +28,7 @@
"approve:hugo": "npm run install:safe && npm approve-scripts --allow-scripts-pin hugo-extended && npm run update:docsy:pack",
"build:preview": "npm run _hugo-dev -- --minify --baseURL \"${DEPLOY_PRIME_URL:-/}\"",
"build:production": "npm run _hugo -- --minify",
"build": "npm run _build -- ",
"build": "cross-env npm run _build -- --baseURL \"${BASE_URL:-http://localhost}\"",
"check:links:internal": "npm run build && npm run _check:links -- --offline",
"check:links": "npm run build && npm run _check:links --",
"ci:prepare": "npm run _get:docsy && hugo mod graph && hugo mod tidy",
Expand All @@ -48,8 +48,8 @@
"test-only": "npm run check:links && npm run test:site",
"test:site": "node --test 'tests/**/*.test.mjs'",
"test": "npm run test-and-fix",
"update:docsy:main": "hugo mod get -u github.com/google/docsy/theme@main && npm run _update:docsy:post",
"update:docsy:mod": "hugo mod get -u github.com/google/docsy/theme && npm run _update:docsy:post",
"update:docsy:main": "hugo mod get -u github.com/docsy/docsy/theme@main && npm run _update:docsy:post",
"update:docsy:mod": "hugo mod get -u github.com/docsy/docsy/theme && npm run _update:docsy:post",
"update:docsy:pack": "hugo mod npm pack && npm pkg set 'name=\"@docsy/hugoautogen\"' private=true --json --prefix packages/hugoautogen && npm install --ignore-scripts",
"update:main": "npm run update:packages && npm run update:docsy:main",
"update:packages": "npm-check-updates -u -x hugo-extended",
Expand All @@ -58,7 +58,7 @@
"devDependencies": {
"autoprefixer": "10.6.1",
"cross-env": "10.1.0",
"hugo-extended": "0.164.0",
"hugo-extended": "0.166.0",
"link-cache": "0.6.0",
"postcss-cli": "12.0.0",
"rtlcss": "4.3.0",
Expand All @@ -77,7 +77,7 @@
},
"allowScripts": {
"@parcel/watcher": false,
"hugo-extended@0.164.0": true
"hugo-extended@0.166.0": true
},
"private": true,
"prettier": {
Expand Down
4 changes: 2 additions & 2 deletions packages/hugoautogen/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@
"bootstrap": "5.3.8"
},
"name": "@docsy/hugoautogen",
"version": "0.1.0",
"private": true
"private": true,
"version": "0.1.0"
}
Loading