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
19 changes: 2 additions & 17 deletions docsy.dev/.prettierignore
Original file line number Diff line number Diff line change
@@ -1,20 +1,5 @@
# cSpell:ignore lookandfeel

/content/**/*.*
!/content/en/about/**/*.*
!/content/en/blog/**/*.*
!/content/en/community/**/*.*
!/content/en/docs/_index.md
!/content/en/docs/best-practices/**/*.*
!/content/en/docs/content/**/*.*
!/content/en/docs/contributing.md
!/content/en/docs/deployment/**/*.*
!/content/en/docs/get-started/**/*.*
!/content/en/docs/language.md
!/content/en/examples/**/*.*
!/content/en/project/**/*.*
!/content/fr/**/*.*
/content/en/docs/updating/convert-site-to-module.md
/content/en/tests/alerts.md

/layouts

/tests/md-output/goldens/**/*.*
17 changes: 12 additions & 5 deletions docsy.dev/content/en/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,24 +41,31 @@ on creating great content for your users.

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

{{% /blocks/lead %}}

{{% blocks/section color="primary" type="row" %}}

{{% blocks/feature icon="fa-lightbulb" title="See Docsy in action!" url="examples/" %}}
As well as our example site, there's a growing number of projects using Docsy for their doc sites.
{{% /blocks/feature %}}

As well as our example site, there's a growing number of projects using Docsy
for their doc sites.

{{% blocks/feature icon="fa-brands fa-github" title="Contributions welcome!" url="https://github.com/google/docsy" %}}
We do a [Pull Request](https://github.com/google/docsy/pulls) contributions workflow on **GitHub**. New users are always welcome!
{{% /blocks/feature %}}

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

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

{{% /blocks/feature %}}

{{% blocks/feature icon="fa-brands fa-x-twitter" title="Follow us on Twitter!" url="https://twitter.com/docsydocs" %}}

Find out about new features and how our users are using Docsy.

{{% /blocks/feature %}}

{{% /blocks/section %}}
10 changes: 5 additions & 5 deletions docsy.dev/content/en/docs/updating/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ weight: 8
---

We hope to continue to make improvements to the theme
[along with the Docsy community](/docs/contributing/). If you have
cloned the example site (or are otherwise using the theme as a Hugo Module or
Git submodule), you can easily update the Docsy theme in your site yourself. If
you have cloned the theme itself into your own project you can also update,
though you may need to resolve merge conflicts.
[along with the Docsy community](/docs/contributing/). If you have cloned the
example site (or are otherwise using the theme as a Hugo Module or Git
submodule), you can easily update the Docsy theme in your site yourself. If you
have cloned the theme itself into your own project you can also update, though
you may need to resolve merge conflicts.

Updating Docsy means that your site will build using the latest version of Docsy
at `HEAD` and include all the new commits or changes that have been merged since
Expand Down
6 changes: 3 additions & 3 deletions docsy.dev/content/en/docs/updating/updating-hugo-module.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ done!

> [!TIP]
>
> If you want to set your module to a certain version inside the Docsy theme repo,
> simply specify the name of the tag representing this version when updating your
> theme, for example:
> If you want to set your module to a certain version inside the Docsy theme
> repo, simply specify the name of the tag representing this version when
> updating your theme, for example:
>
> ```bash
> hugo mod get -u github.com/google/docsy@v{{% param "version" %}}
Expand Down
58 changes: 33 additions & 25 deletions docsy.dev/content/en/docs/updating/updating-submodules.md
Original file line number Diff line number Diff line change
@@ -1,61 +1,69 @@
---
title: "Update Docsy without Hugo Modules"
linkTitle: "Update Docsy without Hugo Modules"
title: Update Docsy without Hugo Modules
weight: 2
description: >
Update the Docsy theme to the latest version using submodules or `git pull`.
---

If you aren't using Hugo Modules, depending on how you chose to install Docsy on your existing site, use one of the following two procedures to update your theme.
If you aren't using Hugo Modules, depending on how you chose to install Docsy on
your existing site, use one of the following two procedures to update your
theme.

> [!TIP]
>
> If you intend to update your site, consider
> [converting your site to Hugo Modules](/docs/updating/convert-site-to-module/).
>After conversion, it's even simpler to update Docsy!
> After conversion, it's even simpler to update Docsy!

## Update your Docsy submodule

If you are using the [Docsy theme as a submodule](/docs/get-started/other-options/#option-1-docsy-as-a-git-submodule) in your project, here's how you update the submodule:
If you are using the
[Docsy theme as a submodule](/docs/get-started/other-options/#option-1-docsy-as-a-git-submodule)
in your project, here's how you update the submodule:

1. Navigate to the root of your local project, then run:

```bash
git submodule update --remote
```
```bash
git submodule update --remote
```

1. Add and then commit the change to your project:

```bash
git add themes/
git commit -m "Updating theme submodule"
```
```bash
git add themes/
git commit -m "Updating theme submodule"
```

1. Push the commit to your project repo. For example, run:

```bash
git push origin master
```
```bash
git push origin master
```

## Route 2: Update your Docsy clone

If you [cloned the Docsy theme](/docs/get-started/other-options/#option-2-clone-the-docsy-theme) into
the `themes` folder in your project, then you use the `git pull` command:
If you
[cloned the Docsy theme](/docs/get-started/other-options/#option-2-clone-the-docsy-theme)
into the `themes` folder in your project, then you use the `git pull` command:

1. Navigate to the `themes` directory in your local project:

```bash
cd themes
```bash
cd themes

```

1. Ensure that `origin` is set to `https://github.com/google/docsy.git`:

```bash
git remote -v
```bash
git remote -v

```

1. Update your local clone:
```bash
git pull origin master
```
```bash
git pull origin master
```

If you have made any local changes to the cloned theme, **you must manually resolve any merge conflicts**.
If you have made any local changes to the cloned theme, **you must manually
resolve any merge conflicts**.
1 change: 0 additions & 1 deletion docsy.dev/content/en/search.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,3 @@ title: Search Results
layout: search
outputs: [HTML]
---

19 changes: 13 additions & 6 deletions docsy.dev/content/en/tests/blocks-cover/color-gradient/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ description: A Hugo theme for creating great technical documentation sites
<!-- prettier-ignore -->
<div class="td-cta-buttons my-5">
<a {{% _param btn-lg primary %}}
href='{{% siteGetPage "/docs/get-started" RelPermalink %}}'>
href='{{% siteGetPage "/docs/get-started" RelPermalink %}}'>
Get started
</a>
<a {{% _param btn-lg secondary %}}
Expand All @@ -42,24 +42,31 @@ on creating great content for your users.

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

{{% /blocks/lead %}}

{{% blocks/section color="primary" type="row" %}}

{{% blocks/feature icon="fa-lightbulb" title="See Docsy in action!" url="/examples/" %}}
As well as our example site, there's a growing number of projects using Docsy for their doc sites.
{{% /blocks/feature %}}

As well as our example site, there's a growing number of projects using Docsy
for their doc sites.

{{% blocks/feature icon="fa-brands fa-github" title="Contributions welcome!" url="https://github.com/google/docsy" %}}
We do a [Pull Request](https://github.com/google/docsy/pulls) contributions workflow on **GitHub**. New users are always welcome!
{{% /blocks/feature %}}

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

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

{{% /blocks/feature %}}

{{% blocks/feature icon="fa-brands fa-x-twitter" title="Follow us on Twitter!" url="https://twitter.com/docsydocs" %}}

Find out about new features and how our users are using Docsy.

{{% /blocks/feature %}}

{{% /blocks/section %}}
19 changes: 13 additions & 6 deletions docsy.dev/content/en/tests/blocks-cover/height-auto/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ description: A Hugo theme for creating great technical documentation sites
<!-- prettier-ignore -->
<div class="td-cta-buttons my-5">
<a {{% _param btn-lg primary %}}
href='{{% siteGetPage "/docs/get-started" RelPermalink %}}'>
href='{{% siteGetPage "/docs/get-started" RelPermalink %}}'>
Get started
</a>
<a {{% _param btn-lg secondary %}}
Expand All @@ -42,24 +42,31 @@ on creating great content for your users.

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

{{% /blocks/lead %}}

{{% blocks/section color="primary" type="row" %}}

{{% blocks/feature icon="fa-lightbulb" title="See Docsy in action!" url="/examples/" %}}
As well as our example site, there's a growing number of projects using Docsy for their doc sites.
{{% /blocks/feature %}}

As well as our example site, there's a growing number of projects using Docsy
for their doc sites.

{{% blocks/feature icon="fa-brands fa-github" title="Contributions welcome!" url="https://github.com/google/docsy" %}}
We do a [Pull Request](https://github.com/google/docsy/pulls) contributions workflow on **GitHub**. New users are always welcome!
{{% /blocks/feature %}}

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

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

{{% /blocks/feature %}}

{{% blocks/feature icon="fa-brands fa-x-twitter" title="Follow us on Twitter!" url="https://twitter.com/docsydocs" %}}

Find out about new features and how our users are using Docsy.

{{% /blocks/feature %}}

{{% /blocks/section %}}
19 changes: 13 additions & 6 deletions docsy.dev/content/en/tests/blocks-cover/height-full/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ description: A Hugo theme for creating great technical documentation sites
<!-- prettier-ignore -->
<div class="td-cta-buttons my-5">
<a {{% _param btn-lg primary %}}
href='{{% siteGetPage "/docs/get-started" RelPermalink %}}'>
href='{{% siteGetPage "/docs/get-started" RelPermalink %}}'>
Get started
</a>
<a {{% _param btn-lg secondary %}}
Expand All @@ -42,24 +42,31 @@ on creating great content for your users.

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

{{% /blocks/lead %}}

{{% blocks/section color="primary" type="row" %}}

{{% blocks/feature icon="fa-lightbulb" title="See Docsy in action!" url="/examples/" %}}
As well as our example site, there's a growing number of projects using Docsy for their doc sites.
{{% /blocks/feature %}}

As well as our example site, there's a growing number of projects using Docsy
for their doc sites.

{{% blocks/feature icon="fa-brands fa-github" title="Contributions welcome!" url="https://github.com/google/docsy" %}}
We do a [Pull Request](https://github.com/google/docsy/pulls) contributions workflow on **GitHub**. New users are always welcome!
{{% /blocks/feature %}}

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

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

{{% /blocks/feature %}}

{{% blocks/feature icon="fa-brands fa-x-twitter" title="Follow us on Twitter!" url="https://twitter.com/docsydocs" %}}

Find out about new features and how our users are using Docsy.

{{% /blocks/feature %}}

{{% /blocks/section %}}
19 changes: 13 additions & 6 deletions docsy.dev/content/en/tests/blocks-cover/height-min/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ params:
<!-- prettier-ignore -->
<div class="td-cta-buttons my-5">
<a {{% _param btn-lg primary %}}
href='{{% siteGetPage "/docs/get-started" RelPermalink %}}'>
href='{{% siteGetPage "/docs/get-started" RelPermalink %}}'>
Get started
</a>
<a {{% _param btn-lg secondary %}}
Expand All @@ -44,24 +44,31 @@ on creating great content for your users.

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

{{% /blocks/lead %}}

{{% blocks/section color="primary" type="row" %}}

{{% blocks/feature icon="fa-lightbulb" title="See Docsy in action!" url="/examples/" %}}
As well as our example site, there's a growing number of projects using Docsy for their doc sites.
{{% /blocks/feature %}}

As well as our example site, there's a growing number of projects using Docsy
for their doc sites.

{{% blocks/feature icon="fa-brands fa-github" title="Contributions welcome!" url="https://github.com/google/docsy" %}}
We do a [Pull Request](https://github.com/google/docsy/pulls) contributions workflow on **GitHub**. New users are always welcome!
{{% /blocks/feature %}}

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

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

{{% /blocks/feature %}}

{{% blocks/feature icon="fa-brands fa-x-twitter" title="Follow us on Twitter!" url="https://twitter.com/docsydocs" %}}

Find out about new features and how our users are using Docsy.

{{% /blocks/feature %}}

{{% /blocks/section %}}
4 changes: 3 additions & 1 deletion docsy.dev/content/en/tests/layouts/no-left-sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ shown, and the main container is centered.

## Section A

This is sample text for the first section. This is sample text for the first section. This is sample text for the first section. This is sample text for the first section.
This is sample text for the first section. This is sample text for the first
section. This is sample text for the first section. This is sample text for the
first section.

### Subsection

Expand Down
Loading
Loading