diff --git a/content/style/shortcodes.md b/content/style/shortcodes.md index 0388b78e4eb..6143845258d 100644 --- a/content/style/shortcodes.md +++ b/content/style/shortcodes.md @@ -286,14 +286,18 @@ and `panel-id`/`panel-link` values must be unique HTML IDs on the page. ## `highlight` shortcode -You can add code examples using the `highlight` shortcode. +You can add code examples using the `highlight` shortcode. For example, this: + + {{}} puts 'Hello, world!' {{}} + + produces: {{< highlight ruby >}} @@ -304,19 +308,23 @@ You can also add line numbers and highlight specific lines. This is the code for this example: + + {{}} require 'chef/config' require 'chef/log' require 'chef/rest' chef_server_url = 'https://chefserver.com' - client_name = 'clientname' - signing_key_filename = '/path/to/pem/for/clientname' + client_name = 'client_name' + signing_key_filename = '/path/to/pem/for/client_name' rest = Chef::REST.new(chef_server_url, client_name, signing_key_filename) puts rest.get_rest('/clients') {{}} + + produces this: {{< highlight ruby "linenos=table,hl_lines=3 5-7,linenostart=10" >}} @@ -325,8 +333,8 @@ require 'chef/log' require 'chef/rest' chef_server_url = 'https://chefserver.com' -client_name = 'clientname' -signing_key_filename = '/path/to/pem/for/clientname' +client_name = 'client_name' +signing_key_filename = '/path/to/pem/for/client_name' rest = Chef::REST.new(chef_server_url, client_name, signing_key_filename) puts rest.get_rest('/clients') diff --git a/content/style/test.md b/content/style/test.md index 350c4ce09d8..2f67de2b195 100644 --- a/content/style/test.md +++ b/content/style/test.md @@ -453,7 +453,6 @@ Checklists are an unordered list with a checkbox. Eiusmod cupidatat excepteur tempor elit officia ipsum aute nulla ea do minim eu eu. - Commodo adipisicing sunt nisi laborum laboris. Code block using the [highlight shortcode](https://gohugo.io/content-management/syntax-highlighting/#example-highlight-shortcode): @@ -464,8 +463,8 @@ require 'chef/log' require 'chef/rest' chef_server_url = 'https://chefserver.com' -client_name = 'clientname' -signing_key_filename = '/path/to/pem/for/clientname' +client_name = 'client_name' +signing_key_filename = '/path/to/pem/for/client_name' rest = Chef::REST.new(chef_server_url, client_name, signing_key_filename) puts rest.get_rest('/clients') @@ -475,19 +474,23 @@ Dolore est deserunt pariatur voluptate. This is the code for this example: + + {{}} require 'chef/config' require 'chef/log' require 'chef/rest' chef_server_url = 'https://chefserver.com' - client_name = 'clientname' - signing_key_filename = '/path/to/pem/for/clientname' + client_name = 'client_name' + signing_key_filename = '/path/to/pem/for/client_name' rest = Chef::REST.new(chef_server_url, client_name, signing_key_filename) puts rest.get_rest('/clients') {{}} + + Add code using the readfile shortcode: {{< readfile file="data/test/test.json" highlight="json" >}}