Skip to content

Commit

Permalink
Lints
Browse files Browse the repository at this point in the history
Signed-off-by: Ian Maddaus <[email protected]>
  • Loading branch information
IanMadd committed Apr 5, 2024
1 parent 8a7ba74 commit a8cd5ad
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 13 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ lint: bundle
hugo -D

update_theme:
hugo mod get -u github.com/chef/chef-docs-theme
HUGO_SECURITY_EXEC_OSENV=".*" hugo mod get -u github.com/chef/chef-docs-theme
hugo mod npm pack

## See:
Expand Down
15 changes: 4 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,26 +144,19 @@ For example:
1. Add the following config information to the `hugo.work` file:

```go
go 1.22.0
go 1.22

use .
use ../path/to/local/chef-docs-theme
```

1. Set the `hugo.work` as an environment variable in your terminal:
1. Start the Hugo local server:

```sh
export HUGO_MODULE_WORKSPACE=hugo.work
make test_theme
```

1. Start the local server:

```sh
make serve_ignore_vendor
```

This Make command ignores the Hugo modules stored in the `_vendor` directory.
If you start Hugo's local server normally, it will continue to source the theme from the `_vendor` directory.
This particular command adds the `hugo.work` file to the Hugo workspace and then ignores the contents of `chef-docs-theme` repo in the `_vendor` directory.

### Test theme branch

Expand Down
1 change: 0 additions & 1 deletion content/style/shortcodes.md
Original file line number Diff line number Diff line change
Expand Up @@ -304,7 +304,6 @@ produces:
puts 'Hello, world!'
{{< / highlight >}}


## `readfile` shortcode

The `readfile` shortcode adds text from a file to a page. You can add a Markdown file, HTML file, or code file by specifying the path to the file from the project root directory.
Expand Down
4 changes: 4 additions & 0 deletions content/style/test.md
Original file line number Diff line number Diff line change
Expand Up @@ -497,12 +497,16 @@ Add code using the readfile shortcode:
And code without syntax highlighting:
<!-- markdownlint-disable MD040 -->
```
describe google_compute_networks(project: 'chef-gcp-inspec') do
its('network_names') { should include 'inspec-network' }
end
```
<!-- markdownlint-enable MD040 -->
### Inline code
This is an `inline block of code`.
Expand Down

0 comments on commit a8cd5ad

Please sign in to comment.