0
0
mirror of https://github.com/twbs/bootstrap.git synced 2024-12-05 17:24:20 +01:00
Bootstrap/site/layouts/shortcodes/scss-docs.html

56 lines
2.2 KiB
HTML
Raw Normal View History

{{- /*
Usage: `scss-docs name="name" file="file/_location.scss"`
2021-01-13 08:34:52 +01:00
Prints everything between `// scss-docs-start "name"` and `// scss-docs-end "name"`
comments in the docs.
2021-01-13 08:34:52 +01:00
Optional parameters:
* strip-default: Remove the ` !default` flag from variable assignments - default: `true`
*/ -}}
{{- $name := .Get "name" -}}
{{- $file := .Get "file" -}}
{{- $strip_default := .Get "strip-default" | default "true" -}}
2021-01-13 08:34:52 +01:00
{{- /* If any parameters are missing, print an error and exit */ -}}
{{- if or (not $name) (not $file) -}}
{{- errorf "%s: %q: Missing required parameters! Got: name=%q file=%q!" .Position .Name $name $file -}}
{{- else -}}
{{- $capture_start := printf "// scss-docs-start %s\n" $name -}}
{{- $capture_end := printf "// scss-docs-end %s" $name -}}
{{- $regex := printf `%s((?:.|\n)*)%s` $capture_start $capture_end -}}
2021-01-13 08:34:52 +01:00
{{- /*
TODO: figure out why we can't do the following and get the first group (the only capturing one)...
$regex := printf `(?:// scss-docs-start %s\n)((?:.|\n)*)(?:\n// scss-docs-end %s)` $name $name
*/ -}}
2021-01-13 08:34:52 +01:00
{{- $match := findRE $regex (readFile $file) -}}
{{- $match = index $match 0 -}}
2021-01-13 08:34:52 +01:00
{{- if not $match -}}
{{- errorf "%s: %q: Got no matches for name=%q in file=%q!" .Position .Name $name $file -}}
{{- end -}}
2021-01-13 08:34:52 +01:00
{{- $match = replace $match $capture_start "" -}}
{{- $match = replace $match $capture_end "" -}}
2021-01-13 08:34:52 +01:00
{{- if (ne $strip_default "false") -}}
{{- $match = replace $match " !default" "" -}}
{{- end -}}
<div class="bd-example-snippet bd-code-snippet bd-scss-docs">
<div class="d-flex align-items-center highlight-toolbar ps-3 pe-2 py-1 border-bottom">
2023-03-08 12:34:10 +01:00
<a class="font-monospace link-secondary link-underline-secondary link-underline-opacity-0 link-underline-opacity-100-hover small" href="{{ .Site.Params.repo }}/blob/v{{ .Site.Params.current_version }}/{{ $file | replaceRE `\\` "/" }}">
{{- $file -}}
</a>
<div class="d-flex ms-auto">
<button type="button" class="btn-clipboard mt-0 me-0" title="Copy to clipboard">
<svg class="bi" aria-hidden="true"><use xlink:href="#clipboard"/></svg>
</button>
</div>
</div>
{{- highlight $match "scss" "" -}}
</div>
2021-01-13 08:34:52 +01:00
{{- end -}}