Mirrors/inspec
2
0
Fork 0
mirror of https://github.com/inspec/inspec synced 2024-11-25 06:00:29 +00:00
Code Issues Projects Releases Packages Wiki Activity

FORMAT: Use html dl, dt, dd tags for displaying subcommands

Browse source 
Signed-off-by: Sonu Saha <sonu.saha@progress.com>
This commit is contained in:
Sonu Saha 2023-02-01 16:32:00 +05:30
parent e70d8091d6
commit 5d9e023828
2 changed files with 718 additions and 539 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1249
docs-chef-io/content/inspec/cli.md
View file

File diff suppressed because it is too large Load diff

8
tasks/docs.rb
View file

@ -59,7 +59,7 @@ class Markdown
end
def dl(msg)
"#{msg.gsub("\n", "\n ")}\n"
"<dl>\n#{msg}</dl>\n"
end
def ul(msg)
@ -177,9 +177,9 @@ namespace :docs do # rubocop:disable Metrics/BlockLength
usage = opt.usage.split(", ")
.map { |x| x.tr("[]", "") }
.map { |x| x.start_with?("-") ? x : "-" + x }
.map { |x| "`" + x + "`" }
msg = "#{usage.join(", ")}\n"
msg << ": #{opt.description}\n" if opt.description && !opt.description.empty?
.map { |x| "<code>" + x + "</code>" }
msg = "<dt>#{usage.join(", ")}</dt>\n"
msg << "<dd> #{opt.description}</dd>\n" if opt.description && !opt.description.empty?
list << f.dl(msg)
end.join
res << f.ul(list)