You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ warnf "Warning: use of `github_url` is deprecated. For details see https://www.docsy.dev/docs/adding-content/repository-links/#github_url-optional" -}}
Copy file name to clipboardexpand all lines: userguide/content/en/docs/Adding content/Shortcodes/index.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -226,7 +226,7 @@ resources:
226
226
227
227
### swaggerui
228
228
229
-
The `swaggerui` shortcode can be placed anywhere inside a page with the [`swagger` layout](https://github.com/google/docsy/tree/master/layouts/swagger); it renders [Swagger UI](https://swagger.io/tools/swagger-ui/) using any OpenAPI YAML or JSON file as source. This can be hosted anywhere you like, for example in your site's root [`/static` folder](/docs/adding-content/content/#adding-static-content).
229
+
The `swaggerui` shortcode can be placed anywhere inside a page with the [`swagger` layout](https://github.com/google/docsy/tree/main/layouts/swagger); it renders [Swagger UI](https://swagger.io/tools/swagger-ui/) using any OpenAPI YAML or JSON file as source. This can be hosted anywhere you like, for example in your site's root [`/static` folder](/docs/adding-content/content/#adding-static-content).
Copy file name to clipboardexpand all lines: userguide/content/en/docs/Adding content/content.md
+7-7
Original file line number
Diff line number
Diff line change
@@ -18,13 +18,13 @@ You can find out more about Hugo directory structure in [Directory Structure Exp
18
18
19
19
Hugo builds your site pages using the content files you provide plus any templates provided by your site's theme. These templates (or *"layouts"* in Hugo terminology) include things like your page's headers, footers, navigation, and links to stylesheets: essentially, everything except your page's specific content. The templates in turn can be made up of *partials*: little reusable snippets of HTML for page elements like headers, search boxes, and more.
20
20
21
-
Because most technical documentation sites have different sections for different types of content, the Docsy theme comes with the [following templates](https://github.com/google/docsy/tree/master/layouts) for top-level site sections that you might need:
21
+
Because most technical documentation sites have different sections for different types of content, the Docsy theme comes with the [following templates](https://github.com/google/docsy/tree/main/layouts) for top-level site sections that you might need:
22
22
23
-
*[`docs`](https://github.com/google/docsy/tree/master/layouts/docs) is for pages in your site's Documentation section.
24
-
*[`blog`](https://github.com/google/docsy/tree/master/layouts/blog) is for pages in your site's Blog.
25
-
*[`community`](https://github.com/google/docsy/tree/master/layouts/community) is for your site's Community page.
23
+
*[`docs`](https://github.com/google/docsy/tree/main/layouts/docs) is for pages in your site's Documentation section.
24
+
*[`blog`](https://github.com/google/docsy/tree/main/layouts/blog) is for pages in your site's Blog.
25
+
*[`community`](https://github.com/google/docsy/tree/main/layouts/community) is for your site's Community page.
26
26
27
-
It also provides a [default "landing page" type of template](https://github.com/google/docsy/tree/master/layouts/_default) with the site header and footer, but no left nav, that you can use for any other section. In this site and our example site it's used for the site [home page](/) and the [About](/about/) page.
27
+
It also provides a [default "landing page" type of template](https://github.com/google/docsy/tree/main/layouts/_default) with the site header and footer, but no left nav, that you can use for any other section. In this site and our example site it's used for the site [home page](/) and the [About](/about/) page.
28
28
29
29
Each top-level **section** in your site corresponds to a **directory** in your site content root. Hugo automatically applies the appropriate **template** for that section, depending on which folder the content is in. For example, this page is in the `docs` subdirectory of the site's content root directory `content/en/`, so Hugo automatically applies the `docs` template. You can override this by explicitly specifying a template or content type for a particular page.
30
30
@@ -158,7 +158,7 @@ You can find out much more about managing resources with Hugo bundles in [Page B
158
158
159
159
## Adding docs and blog posts
160
160
161
-
The template you'll probably use most often is the [`docs` template](https://github.com/google/docsy/blob/master/layouts/docs/baseof.html) (as used in this page) or the very similar [`blog` template](https://github.com/google/docsy/blob/master/layouts/blog/baseof.html). Both these templates include:
161
+
The template you'll probably use most often is the [`docs` template](https://github.com/google/docsy/blob/main/layouts/docs/baseof.html) (as used in this page) or the very similar [`blog` template](https://github.com/google/docsy/blob/main/layouts/blog/baseof.html). Both these templates include:
162
162
163
163
* a left nav
164
164
* GitHub links (populated from your site config) for readers to edit the page or create issues
@@ -236,7 +236,7 @@ If you've copied the example site and you don't want a blog section, or want to
236
236
237
237
## Working with top-level landing pages.
238
238
239
-
Docsy's [default page template](https://github.com/google/docsy/blob/master/layouts/docs/baseof.html) has no left nav and is useful for creating a home page for your site or other "landing" type pages.
239
+
Docsy's [default page template](https://github.com/google/docsy/blob/main/layouts/docs/baseof.html) has no left nav and is useful for creating a home page for your site or other "landing" type pages.
Copy file name to clipboardexpand all lines: userguide/content/en/docs/Adding content/diagrams-and-formulae/index.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -92,7 +92,7 @@ For a complete list of options and their detailed description, have a look at th
92
92
93
93
### Display of Chemical Equations and Physical Units
94
94
95
-
[mhchem](https://www.ctan.org/pkg/mhchem) is a \\(\LaTeX\\) package for typesetting chemical molecular formulae and equations. Fortunately, \\(\KaTeX\\) provides the `mhchem`[extension](https://github.com/KaTeX/KaTeX/tree/master/contrib/mhchem) that makes the `mhchem` package accessible when authoring content for the web. Since this extension was integrated into the Docsy theme, you can write beautiful chemical equations easily once `mhchem` support is enabled inside your `config.toml`:
95
+
[mhchem](https://www.ctan.org/pkg/mhchem) is a \\(\LaTeX\\) package for typesetting chemical molecular formulae and equations. Fortunately, \\(\KaTeX\\) provides the `mhchem`[extension](https://github.com/KaTeX/KaTeX/tree/main/contrib/mhchem) that makes the `mhchem` package accessible when authoring content for the web. Since this extension was integrated into the Docsy theme, you can write beautiful chemical equations easily once `mhchem` support is enabled inside your `config.toml`:
Copy file name to clipboardexpand all lines: userguide/content/en/docs/Adding content/iconsimages.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,7 @@ navbar_logo = true
22
22
```
23
23
24
24
{{% alert title="Tip" %}}
25
-
Your logo is included in the default Docsy navbar as an inline SVG with the following CSS styling (from [`_nav.scss`](https://github.com/google/docsy/blob/master/assets/scss/_nav.scss)):
25
+
Your logo is included in the default Docsy navbar as an inline SVG with the following CSS styling (from [`_nav.scss`](https://github.com/google/docsy/blob/main/assets/scss/_nav.scss)):
-[`assets/scss/`**`_variables_project.scss`**][_variables_project] is where you add project-specific definitions of theme variables such as [site colors](#site-colors), as well as any additional Bootstrap variable values you want to set. You can find a list of Docsy's theme variables and their default values in [<code>assets/scss/<strong>_variables.scss</strong></code>][_variables]. For information about other Bootstrap 4 variables, see [Variable defaults][] and Bootstrap's [v4-dev/scss/_variables.scss][] file.
18
18
-[`assets/scss/`**`_styles_project.scss`**][_styles_project] is where you can add your own custom SCSS styles, including overriding any of the styles in Docsy's theme SCSS files.
@@ -184,7 +184,7 @@ If you need to add some code (CSS import, cookie consent, or similar) to the `he
184
184
layouts/partials/hooks/head-end.html
185
185
```
186
186
187
-
And add the code you need in that file. Your partial code is automatically included just before the end of the theme partial [`head.html`](https://github.com/google/docsy/blob/master/layouts/partials/head.html). The theme version of [`head-end.html`](https://github.com/google/docsy/blob/master/layouts/partials/hooks/head-end.html) is empty.
187
+
And add the code you need in that file. Your partial code is automatically included just before the end of the theme partial [`head.html`](https://github.com/google/docsy/blob/main/layouts/partials/head.html). The theme version of [`head-end.html`](https://github.com/google/docsy/blob/main/layouts/partials/hooks/head-end.html) is empty.
188
188
189
189
190
190
Similarly, if you want to add some code right before the `body` end, create your own version of the following file:
@@ -193,9 +193,9 @@ Similarly, if you want to add some code right before the `body` end, create your
193
193
layouts/partials/hooks/body-end.html
194
194
```
195
195
196
-
Any code in this file is included automatically at the end of the theme partial [`scripts.html`](https://github.com/google/docsy/blob/master/layouts/partials/head.html).
196
+
Any code in this file is included automatically at the end of the theme partial [`scripts.html`](https://github.com/google/docsy/blob/main/layouts/partials/head.html).
197
197
198
-
Both `head.html` and `scripts.html` are then used to build Docsy's [base page layout](https://github.com/google/docsy/blob/master/layouts/_default/baseof.html), which is used by all the other page templates:
198
+
Both `head.html` and `scripts.html` are then used to build Docsy's [base page layout](https://github.com/google/docsy/blob/main/layouts/_default/baseof.html), which is used by all the other page templates:
Copy file name to clipboardexpand all lines: userguide/content/en/docs/Best practices/organizing-content.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -29,7 +29,7 @@ You may also want to create some tasks/how-tos for your project's features. Feel
29
29
site or even just the docs section instead if you like this simpler structure better.
30
30
31
31
{{% alert title="Tip" %}}
32
-
If you want to copy this guide, be aware that its [source files](https://github.com/google/docsy/tree/master/userguide) are *inside* the Docsy theme repo, and so it doesn't have its own `themes/` directory: instead, we run `hugo server --themesDir ../..` to use Docsy from its parent directory. You may want to either copy the site and [add a `themes/` directory with Docsy](/docs/getting-started/#option-2-use-the-docsy-theme-in-your-own-site), or just copy the `docs/` folder into your existing site's content root.
32
+
If you want to copy this guide, be aware that its [source files](https://github.com/google/docsy/tree/main/userguide) are *inside* the Docsy theme repo, and so it doesn't have its own `themes/` directory: instead, we run `hugo server --themesDir ../..` to use Docsy from its parent directory. You may want to either copy the site and [add a `themes/` directory with Docsy](/docs/getting-started/#option-2-use-the-docsy-theme-in-your-own-site), or just copy the `docs/` folder into your existing site's content root.
33
33
{{% /alert %}}
34
34
35
35
[Learn more about how Hugo and Docsy use folders and other files to organize your site](/docs/adding-content/content/#organizing-your-documentation).
Copy file name to clipboardexpand all lines: userguide/content/en/docs/Deployment/_index.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -66,14 +66,14 @@ For example, if you want to use a version of `postcss-cli` later than version 8.
66
66
67
67
```
68
68
"devDependencies": {
69
-
"autoprefixer": "^9.8.6",
69
+
"autoprefixer": "^9.8.8",
70
70
"postcss-cli": "^8.0.0",
71
71
"postcss": "^8.0.0"
72
72
}
73
73
```
74
74
{{% /alert %}}
75
75
76
-
Alternatively, you can follow the same instructions but specify your **Deploy settings** in a [`netlify.toml` file](https://docs.netlify.com/configure-builds/file-based-configuration/) in your repo rather than in the **Deploy settings** page. You can see an example of this in the [Docsy theme repo](https://github.com/google/docsy/blob/master/netlify.toml) (though note that the build command here is a little unusual because the Docsy user guide is *inside* the theme repo).
76
+
Alternatively, you can follow the same instructions but specify your **Deploy settings** in a [`netlify.toml` file](https://docs.netlify.com/configure-builds/file-based-configuration/) in your repo rather than in the **Deploy settings** page. You can see an example of this in the [Docsy theme repo](https://github.com/google/docsy/blob/main/netlify.toml) (though note that the build command here is a little unusual because the Docsy user guide is *inside* the theme repo).
77
77
78
78
If you have an existing deployment you can view and update the relevant information by selecting the site from your list of sites in Netlify, then clicking **Site settings** - **Build and deploy**. Ensure that **Ubuntu Xenial 16.04** is selected in the **Build image selection** section - if you're creating a new deployment this is used by default. You need to use this image to run the extended version of Hugo.
0 commit comments