-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy path.scribeconf
More file actions
18 lines (18 loc) · 1.59 KB
/
.scribeconf
File metadata and controls
18 lines (18 loc) · 1.59 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
doc_path = ./docs # Destination folder for generated files
doc_filename = shell_doc # Base name of the generated file
format = markdown # Output format
generate_index = false # Creates an index file for multiple scripts (true, [false])
log_level = normal # log_level level (normal, verbose)
show_toc = false # Enables table of contents (true, [false])
show_alerts = false # Displays alert blocks (true, [false])
show_shellcheck = false # Displays shellcheck directives (true, [false])
shellcheck_display = sequential # Presentation style for shellcheck results (table, [sequential])
highlight_code = true # Enables syntax highlighting
highlight_language = bash # Language for example code highlighting ([bash])
example_display = sequential # Presentation style for examples (tabs, [sequential])
arguments_display = sequential # Presentation style for arguments (table, [sequential])
traverse_symlinks = true # Follow symbolic links when processing directories
linkify_usernames = false # Convert GitHub usernames to links (true, [false])
version_placement = about # Where to display version info ([about], filename)
copyright_placement = about # Where to display copyright info ([about], footer)
license_placement = about # Where to display license info ([about], footer)