From a8cd5ad5458c24f2bb3ab1d0c9b9eb236990634b Mon Sep 17 00:00:00 2001 From: Ian Maddaus Date: Fri, 5 Apr 2024 16:19:29 -0400 Subject: [PATCH] Lints Signed-off-by: Ian Maddaus --- Makefile | 2 +- README.md | 15 ++++----------- content/style/shortcodes.md | 1 - content/style/test.md | 4 ++++ 4 files changed, 9 insertions(+), 13 deletions(-) diff --git a/Makefile b/Makefile index 18dd50b015a..3ab94a1de28 100644 --- a/Makefile +++ b/Makefile @@ -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: diff --git a/README.md b/README.md index a24f5317c7d..ff7ebc460c8 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/content/style/shortcodes.md b/content/style/shortcodes.md index a02ae985f94..ae49b13e540 100644 --- a/content/style/shortcodes.md +++ b/content/style/shortcodes.md @@ -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. diff --git a/content/style/test.md b/content/style/test.md index 1a47472b928..70ccbec9dec 100644 --- a/content/style/test.md +++ b/content/style/test.md @@ -497,12 +497,16 @@ Add code using the readfile shortcode: And code without syntax highlighting: + + ``` describe google_compute_networks(project: 'chef-gcp-inspec') do its('network_names') { should include 'inspec-network' } end ``` + + ### Inline code This is an `inline block of code`.