-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy path_config.yml
More file actions
162 lines (132 loc) · 7.35 KB
/
Copy path_config.yml
File metadata and controls
162 lines (132 loc) · 7.35 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
# =============================================================================
# NBS 7 System Administrator Guide — Jekyll Site Configuration
# Theme: just-the-docs https://just-the-docs.com
# =============================================================================
# -----------------------------------------------------------------------------
# Site identity
# -----------------------------------------------------------------------------
title: NBS 7.12 System Administrator Guide
description: National Electronic Disease Surveillance System Base System (NBS 7) System Administrator Guide
# Current release version — update both values at the start of each release cycle.
# Use {{ site.version_latest }} in page content for the version number (e.g., 7.12).
# Use {{ site.version_latest_tag }} for pinned GitHub links (e.g., v7.12.0).
# When archiving a release, do a global find-and-replace of these variables with
# hardcoded values before moving files to _previous_versions/.
version_latest: "7.12"
version_latest_tag: "v7.12.0"
# Canonical URL for the deployed site — used by JTD to build absolute links and by the Jekyll sitemap plugin.
url: https://cdcgov.github.io
baseurl: /NEDSS-SystemAdminGuide
# -----------------------------------------------------------------------------
# Theme and visual identity
# -----------------------------------------------------------------------------
theme: just-the-docs
plugins:
- jekyll-redirect-from
# Custom color scheme — defined in _sass/color_schemes/colors.scss.
# The value here must match the filename (without .scss).
color_scheme: colors
# Logo displayed in the upper-left nav panel.
logo: "/assets/images/CDC-logo-200x43.png"
# -----------------------------------------------------------------------------
# Navigation
# -----------------------------------------------------------------------------
# External link rendered in the top-right corner of every page.
# Remove this key entirely if you don't want the link to appear.
aux_links:
GitHub Repository: https://github.com/CDCgov/NEDSS-SystemAdminGuide
# -----------------------------------------------------------------------------
# Table of contents (in-page TOC generated by JTD)
# min_level / max_level control which heading levels appear in the on-page TOC.
# Current setting: H2 only. H3+ headings do not appear in the TOC.
# To also surface H3 subsections, change max_level to 3.
# -----------------------------------------------------------------------------
kramdown:
toc_levels: 2..2 # {:toc} includes H2 only — H1 is the page title, H3+ are too granular
# -----------------------------------------------------------------------------
# Page-level features
# -----------------------------------------------------------------------------
# Render a clickable anchor (#) next to each heading on hover.
heading_anchors: true
# Render a "Back to top" button at the bottom of long pages.
back_to_top: true
back_to_top_text: "Back to top"
# Show a "last edited" timestamp on pages that include `last_modified_date:`
# in their front matter. Format uses Ruby's strftime syntax:
# https://ruby-doc.org/stdlib-2.7.0/libdoc/time/rdoc/Time.html
last_edit_timestamp: true
last_edit_time_format: "%b %e %Y at %I:%M %p"
# -----------------------------------------------------------------------------
# Footer
# NOTE: The inline <script> in footer_content renders the year dynamically.
# This is a known 508 / CSP concern — inline scripts may be blocked by strict
# Content Security Policy headers. Do not change until CSP policy is reviewed.
# -----------------------------------------------------------------------------
# Comment out the CDC copyright footer by request from @Alex Bielen (2026-04-17).
# footer_content: "<p style=\"font-size: 12px; font-style: italic;\">© <script>document.write(new Date().getFullYear())</script> Centers for Disease Control and Prevention (CDC). All Rights Reserved.</p>"
# -----------------------------------------------------------------------------
# Callouts (admonition blocks)
# Usage: wrap a block quote in the callout class — see contributing/styles.md for syntax.
# Each type maps to a named color scale in _sass/color_schemes/colors.scss.
# callouts_level defaults to "quiet" (light scheme) or "loud" (dark scheme).
# Omitting callouts_level keeps the JTD default — quiet for this light scheme.
# -----------------------------------------------------------------------------
callouts:
highlight:
color: purple # Purple scale — title-less; use for inline emphasis
important:
title: Important
color: yellow # Yellow scale — required actions and prerequisites
new:
title: New
color: green # Green scale — recently added content or features
note:
title: Note
color: blue # Blue scale — helpful context that isn't critical
warning:
title: Warning
color: red # Red scale — destructive actions, risks, or breakage
# -----------------------------------------------------------------------------
# Collections — non-standard content directories Jekyll should process
# -----------------------------------------------------------------------------
collections:
guide_preview:
output: true
directory: _guide_preview # Draft / preview content (hidden from nav and search)
previous_versions:
output: true
directory: _previous_versions # Archived release docs (visible in nav)
# -----------------------------------------------------------------------------
# just-the-docs collection configuration
# Controls how each collection above appears in the left-nav and search index.
# NOTE: This key must appear only once. A second just_the_docs: declaration
# silently overrides the first — this was the source of a prior config bug.
# -----------------------------------------------------------------------------
just_the_docs:
collections:
guide_preview:
nav_exclude: true # Hide from left nav — draft content, not ready for readers
search_exclude: true # Exclude from search — prevents confusing draft results
previous_versions:
name: "Previous Versions"
nav_exclude: false # Show in left nav under the "Previous Versions" label
search_exclude: false # Include in search so older release docs are findable
# -----------------------------------------------------------------------------
# Exclude from Jekyll processing
# templates/ contains contributor starter files with unfilled placeholders.
# Excluding it prevents Jekyll from building them as site pages and adding
# placeholder titles (e.g. "TITLE") to the left nav.
# -----------------------------------------------------------------------------
exclude:
- templates/
# -----------------------------------------------------------------------------
# GitHub "Edit this page" link (currently disabled)
# Activate to show an "Edit this page on GitHub" link on each page.
# Uncomment all five settings together — partial activation produces broken links.
# Requires that docs live at a predictable path relative to the repo root.
# -----------------------------------------------------------------------------
# gh_edit_link: true
# gh_edit_link_text: "Edit this page on GitHub."
# gh_edit_repository: "https://github.com/CDCgov/NEDSS-SystemAdminGuide"
# gh_edit_branch: "main"
# gh_edit_view_mode: "tree" # "tree" = view file; "edit" = open GitHub editor directly