Merge branch 'google:main' into patch-3

.gitignore

@@ -15,4 +15,7 @@ resources/
 
 # IDE files
 .idea
-.vscode
+
+# VS Code
+/.vscode/**
+!/.vscode/cspell.json

.gitmodules

@@ -1,9 +1,7 @@
 [submodule "assets/vendor/bootstrap"]
 	path = assets/vendor/bootstrap
 	url = https://github.com/twbs/bootstrap.git
-	shallow = true
 	branch = v4-dev
 [submodule "assets/vendor/Font-Awesome"]
 	path = assets/vendor/Font-Awesome
 	url = https://github.com/FortAwesome/Font-Awesome.git
-	shallow = true

.vscode/cspell.json

@@ -0,0 +1,10 @@
+// For settings, see https://www.streetsidesoftware.com/vscode-spell-checker/docs/configuration/
+{
+    "version": "0.2",
+    "caseSensitive": true,
+    "words": [
+        "Docsy",
+        "shortcode",
+        "shortcodes"
+    ]
+}

CHANGELOG.md

@@ -0,0 +1,42 @@
+# Changelog
+
+Useful links: Docsy [releases][] & [tags][]. Jump to the [latest][] release.
+
+For a list of issues targeted for the next release, see the [22Q2][] milestone.
+
+## [0.3.0][] - next release (unpublished yet)
+
+**Breaking changes**:
+
+- Upgrade to [Algolia DocSearch v3](https://docsearch.algolia.com/docs/DocSearch-v3).
+  If your site uses the deprecated DocSearch v2, you must 
+  [update your DocSearch code](https://docsearch.algolia.com/docs/migrating-from-v2).
+
+**Details**:
+
+- See the [release notes][0.3.0]
+
+## [0.2.0][]
+
+**New**:
+
+- Add official Docsy support for [Hugo modules][]. Many thanks to the dedicated and
+  patient efforts of [@deining][], who researched, experimented, and implemented
+  this feature. Thanks to [@deining][] and [@LisaFC][] for the doc updates.
+
+  For details, see [Migrate to Hugo Modules](https://www.docsy.dev/docs/updating/convert-site-to-module/).
+
+**Details**:
+
+- See the [release notes][0.2.0]
+
+
+[@deining]: https://github.com/deining
+[@LisaFC]: https://github.com/LisaFC
+[0.2.0]: https://github.com/google/docsy/releases/v0.2.0
+[0.3.0]: https://github.com/google/docsy/releases/v0.3.0
+[22Q2]: https://github.com/google/docsy/milestone/3
+[Hugo modules]: https://gohugo.io/hugo-modules/
+[latest]: https://github.com/google/docsy/releases/latest
+[releases]: https://github.com/google/docsy/releases
+[tags]: https://github.com/google/docsy/tags

README.md

@@ -27,15 +27,15 @@ The following are basic prerequisites for using Docsy in your site:
 
 You can find an example project that uses Docsy in the [Docsy Example Project
 repo](https://github.com/google/docsy-example).The Docsy Example Project is
-hosted at [https://example.docsy.dev](https://example.docsy.dev). For
+hosted at [example.docsy.dev](https://example.docsy.dev). For
 real-life examples of sites that use Docsy (and their source repos), see our
 [Examples](https://www.docsy.dev/docs/examples/) page.
 
 To use the Docsy theme for your own site:
 
 - (Recommended) Use the [example
   project](https://github.com/google/docsy-example), which includes the Docsy
-  theme as a submodule, as a template to create your project. You can customize
+  theme as a Hugo module, as a template to create your project. You can customize
   this pre-configured basic site into your own Docsy themed site. [Learn
   more...](https://github.com/google/docsy-example)
 
@@ -49,14 +49,16 @@ for details about the various usage options.
 ## Documentation
 
 Docsy has its own user guide (using Docsy, of course!) with lots more
-information about using the theme, which you can find at
-[https://docsy.dev](https://docsy.dev). Alternatively you can use Hugo to
-generate and serve a local copy of the guide (also useful for testing local
-theme changes), making sure you have installed all the prerequisites listed
-above:
+information about using the theme. It is hosted by [Netlify][] at
+[docsy.dev](https://docsy.dev). For deploy logs and more, see [Deploys][] from
+the site's Netlify dashboard.
+
+Alternatively you can use Hugo to generate and serve a local copy of the guide
+(also useful for testing local theme changes), making sure you have installed
+all the prerequisites listed above:
 
 ```console
-$ git clone --recurse-submodules --depth 1 https://github.com/google/docsy.git
+$ git clone --depth 1 https://github.com/google/docsy.git
 $ cd docsy/userguide/
 $ npm install
 $ npm run serve
@@ -65,7 +67,7 @@ $ npm run serve
 ## Contributing ![GitHub](https://img.shields.io/github/contributors/google/docsy)
 
 Please read
-[CONTRIBUTING.md](https://github.com/google/docsy/blob/master/CONTRIBUTING.md)
+[CONTRIBUTING.md](https://github.com/google/docsy/blob/main/CONTRIBUTING.md)
 for details on our code of conduct, and the process for submitting pull requests
 to us. See also the list of
 [contributors](https://github.com/google/docsy/graphs/contributors) who
@@ -74,5 +76,8 @@ participated in this project.
 ## License ![GitHub](https://img.shields.io/github/license/google/docsy)
 
 This project is licensed under the Apache License 2.0 - see the
-[LICENSE.md](https://github.com/google/docsy/blob/master/LICENSE) file for
+[LICENSE.md](https://github.com/google/docsy/blob/main/LICENSE) file for
 details
+
+[Deploys]: https://app.netlify.com/sites/docsydocs/deploys
+[Netlify]: https://netlify.com

dependencies/go.mod

@@ -1,3 +1,8 @@
 module github.com/google/docsy/dependencies
 
 go 1.12
+
+require (
+	github.com/FortAwesome/Font-Awesome v0.0.0-20210804190922-7d3d774145ac // indirect
+	github.com/twbs/bootstrap v4.6.1+incompatible // indirect
+)

go.mod

@@ -4,6 +4,6 @@ go 1.12
 
 require (
 	github.com/FortAwesome/Font-Awesome v0.0.0-20210804190922-7d3d774145ac // indirect
-	github.com/google/docsy/dependencies v0.2.0-pre // indirect
+	github.com/google/docsy/dependencies v0.2.0 // indirect
 	github.com/twbs/bootstrap v4.6.1+incompatible // indirect
 )

i18n/de.toml

@@ -1,5 +1,3 @@
-
-
 # UI strings. Buttons and similar.
 
 [ui_pager_prev]

i18n/ru.toml

@@ -1,5 +1,3 @@
-
-
 # UI strings. Buttons and similar.
 
 [ui_pager_prev]
@@ -18,6 +16,10 @@ other = "Поиск по сайту…"
 [ui_in]
 other = "в"
 
+# Used in sentences such as "All Tags"
+[ui_all]
+other = "всё"
+
 # Footer text
 [footer_all_rights_reserved]
 other = "Все права защищены"
@@ -35,43 +37,45 @@ other = "Создано"
 other = "Изменено"
 [post_edit_this]
 other = "Отредактировать страницу"
+[post_view_this]
+other = "Увидеть источник страницы"
 [post_create_child_page]
-other = "Create child page"
+other = "Создать дополнительную страницу"
 [post_create_issue]
 other = "Предложить изменения документации"
 [post_create_project_issue]
 other = "Предложить доработки по проекту"
 [post_posts_in]
 other = "Публикации в"
 [post_reading_time]
-other = "minute read"
+other = "минутное чтение"
 [post_less_than_a_minute_read]
-other = "less than a minute"
+other = "меньше минуты"
 
 # Print support
 [print_printable_section]
-other = "This is the multi-page printable view of this section."
+other = "Это многостраничный печатный вид этого раздела."
 [print_click_to_print]
-other = "Click here to print"
+other = "Нажмите что бы печатать"
 [print_show_regular]
-other = "Return to the regular view of this page"
+other = "Вернуться к обычному просмотру страницы"
 [print_entire_section]
-other = "Print entire section"
+other = "Печатать весь раздел"
 
 # Community
 [community_join]
-other = "Join the {{ .Site.Title }} community"
+other = "Присоединяйтесь к {{ .Site.Title }} комьюнити"
 [community_introduce]
-other = "{{ .Site.Title }} is an open source project that anyone in the community can use, improve, and enjoy. We'd love you to join us! Here's a few ways to find out what's happening and get involved."
+other = "{{ .Site.Title }} - это проект с открытым кодом который любой в комьюнити может использовать, улучшать и наслаждаться. Мы будем рады видеть тебя с нами! Вот несколько путей как присоединиться к нам, знать что происходит и быть вовлеченным."
 [community_learn]
-other = "Learn and Connect"
+other = "Изучай и Присоединяйся"
 [community_using]
-other = "Using or want to use {{ .Site.Title }}? Find out more here:"
+other = "Уже пользуешься или хочешь пользоваться {{ .Site.Title }}? Узнай больше здесь:"
 [community_develop]
-other = "Develop and Contribute"
+other = "Розвивай и Вноси свой вклад"
 [community_contribute]
-other = "If you want to get more involved by contributing to {{ .Site.Title }}, join us here:"
+other = "Если ты хочешь принять более активное участие, внося свой вклад в {{ .Site.Title }}, присоединяйся к нам тут:"
 [community_how_to]
-other = "You can find out how to contribute to these docs in our"
+other = "Ты можешь узнать как сделать вклад в эти документы в нашем"
 [community_guideline]
-other = "Contribution Guidelines"
+other = "Рекомендации касательно вклада"

i18n/uk.toml

@@ -0,0 +1,81 @@
+# UI strings. Buttons and similar.
+
+[ui_pager_prev]
+other = "Попередня"
+
+[ui_pager_next]
+other = "Наступна"
+
+[ui_read_more]
+other = "Детальніше"
+
+[ui_search]
+other = "Пошук по сайту…"
+
+# Used in sentences such as "Posted in News"
+[ui_in]
+other = "у"
+
+# Used in sentences such as "All Tags"
+[ui_all]
+other = "все"
+
+# Footer text
+[footer_all_rights_reserved]
+other = "Усі права захищені"
+
+[footer_privacy_policy]
+other = "Політика конфіденційності"
+
+
+# Post (blog, articles etc.)
+[post_byline_by]
+other = "Автор"
+[post_created]
+other = "Створено"
+[post_last_mod]
+other = "Змінено"
+[post_edit_this]
+other = "Відредагувати сторінку"
+[post_view_this]
+other = "Побачити джерело сторінки"
+[post_create_child_page]
+other = "Створити додаткову сторінку"
+[post_create_issue]
+other = "Запропонувати змінення документації"
+[post_create_project_issue]
+other = "Запропонувати допрацювання по проекту"
+[post_posts_in]
+other = "Публикації у"
+[post_reading_time]
+other = "хвилина читання"
+[post_less_than_a_minute_read]
+other = "менше хвилини"
+
+# Print support
+[print_printable_section]
+other = "Це багатосторінковий друкований вигляд цього розділу."
+[print_click_to_print]
+other = "Натисність щоб друкувати"
+[print_show_regular]
+other = "Повернутися до звичайного перегляду сторінки"
+[print_entire_section]
+other = "Друкувати увесь розділ"
+
+# Community
+[community_join]
+other = "Приєднуйтесь до {{ .Site.Title }} спільноти"
+[community_introduce]
+other = "{{ .Site.Title }} - це проект з відкритим кодом, який будь-хто в спільноті може використовувати, покращувати та насолоджуватися. Ми будемо раді бачити тебе з нами! Ось декілька опцій щоб знати що відбувається та залучитись."
+[community_learn]
+other = "Вивчай та Приєднуйся"
+[community_using]
+other = "Користуєшся чи хотів би користуватись {{ .Site.Title }}? Дізнайся більше тут:"
+[community_develop]
+other = "Розвивай та Роби внесок"
+[community_contribute]
+other = "Якщо хочеш бути більш залученим, роблячи внесок у {{ .Site.Title }}, приєднуйся до нас тут:"
+[community_how_to]
+other = "Дізнайся як зробити внесок до цих документів в нашому"
+[community_guideline]
+other = "Рекомендації щодо внеску"

layouts/partials/community_links.html

@@ -14,7 +14,7 @@ <h2>{{ T "community_develop" }}</h2>
         {{ with index $links "developer"}}
         {{ template "community-links-list" . }}
         {{ end }}
-        <p>{{ T "community_how_to" }} <a href="../docs/contribution-guidelines/">{{ T "community_guideline" }}</a>
+        <p>{{ T "community_how_to" }} <a href="/docs/contribution-guidelines/">{{ T "community_guideline" }}</a>
     </div>
 </section>
 

layouts/partials/page-meta-links.html

@@ -4,7 +4,7 @@
 {{ $gh_url := ($.Param "github_url") -}}
 {{ $gh_subdir := ($.Param "github_subdir") -}}
 {{ $gh_project_repo := ($.Param "github_project_repo") -}}
-{{ $gh_branch := (default "master" ($.Param "github_branch")) -}}
+{{ $gh_branch := (default "main" ($.Param "github_branch")) -}}
 <div class="td-page-meta ml-2 pb-1 pt-2 mb-0">
 {{ if $gh_url -}}
   {{ warnf "Warning: use of `github_url` is deprecated. For details see https://www.docsy.dev/docs/adding-content/repository-links/#github_url-optional" -}}

layouts/partials/search-input.html

@@ -1,5 +1,7 @@
-{{ if or .Site.Params.gcs_engine_id .Site.Params.algolia_docsearch -}}
+{{ if .Site.Params.gcs_engine_id -}}
 <input type="search" class="form-control td-search-input" placeholder="&#xf002; {{ T "ui_search" }}" aria-label="{{ T "ui_search" }}" autocomplete="off">
+{{ else if .Site.Params.algolia_docsearch -}}
+<div id="docsearch"></div>
 {{ else if .Site.Params.offlineSearch -}}
 {{ $offlineSearchIndex := resources.Get "json/offline-search-index.json" | resources.ExecuteAsTemplate "offline-search-index.json" . -}}
 {{ if hugo.IsProduction -}}

netlify.toml

@@ -6,7 +6,7 @@ publish = "userguide/public"
 command = "npm run docs-install && npm run build:preview"
 
 [build.environment]
-GO_VERSION = "1.17.7"
+GO_VERSION = "1.18"
 HUGO_THEME = "repo"
 
 [context.production]

package.json

@@ -1,20 +1,22 @@
 {
   "name": "docsy",
-  "version": "0.2.0-dev",
+  "version": "0.2.0",
   "repository": "github:google/docsy",
   "scripts": {
-    "_docs": "cd userguide && npm run",
-    "build:preview": "npm run _docs build:preview",
-    "build:production": "npm run _docs build:production",
-    "build": "npm run _docs build",
-    "docs-install": "cd userguide && npm install",
-    "serve": "npm run _docs serve"
+    "_cd:docs": "cd userguide &&",
+    "build:preview": "npm run cd:docs build:preview",
+    "build:production": "npm run cd:docs build:production",
+    "build": "npm run cd:docs build",
+    "cd:docs": "npm run _cd:docs -- npm run",
+    "docs-install": "npm run _cd:docs -- npm install",
+    "get:submodule": "set -x && git submodule update --init ${DEPTH:- --depth 1}",
+    "serve": "npm run cd:docs serve"
   },
   "dependencies": {
     "@fortawesome/fontawesome-free": "^5.15.4",
     "bootstrap": "^4.6.1"
   },
   "devDependencies": {
-    "hugo-extended": "0.93.2"
+    "hugo-extended": "0.96.0"
   }
 }

theme.toml

@@ -1,6 +1,6 @@
 name = "Docsy"
 license = "Apache 2.0"
-licenselink = "https://github.com/google/docsy/blob/master/LICENSE"
+licenselink = "https://github.com/google/docsy/blob/main/LICENSE"
 description = "A Hugo theme for technical documentation sites"
 homepage = "https://docsy.dev"
 tags = ["documentation", "multilingual", "customizable", "responsive", "docs"]