Skip to content
This repository was archived by the owner on Mar 1, 2024. It is now read-only.

Commit 194c497

Browse files
Update documentation
1 parent 315346d commit 194c497

File tree

1 file changed

+7
-8
lines changed
  • exampleSite/content/getting-started

1 file changed

+7
-8
lines changed

exampleSite/content/getting-started/index.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,9 @@ git clone git@github.com:digitalcraftsman/hugo-material-docs.git
3434

3535
## Setup
3636

37-
Next, take a look in the `exampleSite` folder at `themes/hugo-material-docs/`. This directory contains an example config file and the content that you are currently reading. It serves as an example setup for your documentation.
37+
Next, take a look in the `exampleSite` folder at `themes/hugo-material-docs/`. This directory contains an example config file and the content that you are currently reading. It serves as an example setup for your documentation.
3838

39-
Copy at least the `config.toml` in the root directory of your website. Overwrite the existing config file if necessary.
39+
Copy at least the `config.toml` in the root directory of your website. Overwrite the existing config file if necessary.
4040

4141
Hugo includes a development server, so you can view your changes as you go -
4242
very handy. Spin it up with the following command:
@@ -54,7 +54,7 @@ on and customize the theme through some options.
5454
Before you are able to deploy your documentation you should take a few minute to adjust some information in the `config.toml`. Open the file in an editor:
5555

5656
```toml
57-
baseurl = "http://replace-this-with-your-hugo-site.com/"
57+
baseurl = "https://example.com/"
5858
languageCode = "en-us"
5959
title = "Material Docs"
6060

@@ -100,7 +100,7 @@ If your project has a logo, you can add it to the drawer/navigation by defining
100100
the variable `logo`. Ideally, the image of your logo should have
101101
rectangular shape with a minimum resolution of 128x128 and leave some room
102102
towards the edges. The logo will also be used as a web application icon on iOS.
103-
Save your logo somewhere in the `static/` folder and reference the file relative to this location:
103+
Either save your logo somewhere in the `static/` folder and reference the file relative to this location or use an external URL:
104104

105105
```toml
106106
[params]
@@ -109,7 +109,7 @@ Save your logo somewhere in the `static/` folder and reference the file relative
109109

110110
### Adding a custom favicon
111111

112-
Favicons are small small icons that are displayed in the tabs right next to the title of the current page. As with the logo above you need to save your favicon in `static/` and link it relative to this folder in the config file:
112+
Favicons are small small icons that are displayed in the tabs right next to the title of the current page. As with the logo above you need to save your favicon in `static/` and link it relative to this folder or use an external URL:
113113

114114
```toml
115115
[params]
@@ -127,9 +127,8 @@ googleAnalytics = "UA-XXXXXXXX-X"
127127
### Small tweaks
128128

129129
This theme provides a simple way for making small adjustments, that is changing
130-
some margins, centering text, etc. Simply put the CSS and Javascript files that
131-
contain your adjustments in the `static/` directory (ideally in subdirectories of their own) and include them via the `custom_css` and `custom_js`
132-
variables in your `config.toml`. Reference the files relative to `static/`:
130+
some margins, centering text, etc. The `custom_css` and `custom_js` option allow you to add further CSS and JS files. They can either reside locally in the `/static` folder or on an external server, e.g. a CDN. In both cases use either the relative path to `/static` or the absolute URL to the external ressource.
131+
133132

134133
```toml
135134
[params]

0 commit comments

Comments
 (0)