nhs-notify-supplier-api/docs/_config.yml at a342f1ea0fed0c4eeb97242ebb43ede98a6c8fc2 · NHSDigital/nhs-notify-supplier-api · GitHub

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
# Welcome to Jekyll!
#
# This config file is meant for settings that affect your whole blog, values
# which you are expected to set up once and rarely edit after that. If you find
# yourself editing this file very often, consider using Jekyll's data files
# feature for the data you need to update frequently.
#
# For technical reasons, this file is *NOT* reloaded automatically when you use
# 'bundle exec jekyll serve'. If you change this file, please restart the server process.
#
# If you need help with YAML syntax, here are some quick references for you:
# https://learn-the-web.algonquindesign.ca/topics/markdown-yaml-cheat-sheet/#yaml
# https://learnxinyminutes.com/docs/yaml/
#
# Site settings
# These are used to personalize your new site. If you look in the HTML files,
# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
# You can create any custom variable you would like, and they will be accessible
# in the templates via {{ site.myvariable }}.

title: NHS Notify Supplier API
# email: your-email@example.com
description: >- # this means to ignore newlines until "baseurl:"
  Documentation for the NHS Notify Supplier API
baseurl: "" # the subpath of your site, e.g. /blog
url: "https://nhsdigital.github.io" # the base hostname & protocol for your site, e.g. http://example.com

collections_dir: collections

collections:
  consumers:
    output: true
    sort_by: order
  developers:
    output: true
    sort_by: order

just_the_docs:
  collections:
    consumers:
      name: API Consumers
    developers:
      name: API Developers

defaults:
  - scope:
      path: ""
      type: "consumers"
    values:
      layout: "page"
      is_not_draft: false
      owner: NHS Notify
      author: NHS Notify
      last_modified_date: 2025-10-08
  - scope:
      path: ""
      type: "developers"
    values:
      layout: "page"
      is_not_draft: false
      owner: NHS Notify
      author: NHS Notify
      last_modified_date: 2025-10-08

# Build settings
theme: just-the-docs
plugins:
  - jekyll-feed
  - jemoji

color_scheme: nhs
mermaid:
  # Version of mermaid library
  # Pick an available version from https://cdn.jsdelivr.net/npm/mermaid/
  version: "10.9.1"

aux_links:
  "NHS Notify Supplier API Template on GitHub":
    - "//github.com/NHSDigital/nhs-notify-supplier-api"

aux_links_new_tab: false

# Footer "Edit this page on GitHub" link text
gh_edit_link: true # show or hide edit this page link
gh_edit_link_text: "Edit this page on GitHub."
gh_edit_repository: "https://github.com/NHSDigital/nhs-notify-supplier-api" # the github URL for your repo
gh_edit_branch: "main" # the branch that your docs is served from
# gh_edit_source: docs # the source that your files originate from
gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately

nav_external_links:
  - title: Notify Service Catalogue
    url: https://digital.nhs.uk/services/nhs-notify
    hide_icon: false # set to true to hide the external link icon - defaults to false
    opens_in_new_tab: false # set to true to open this link in a new tab - defaults to false

  - title: Notify Tech Docs
    url: https://nhsdigital.github.io/nhs-notify/
    hide_icon: false # set to true to hide the external link icon - defaults to false
    opens_in_new_tab: false # set to true to open this link in a new tab - defaults to false

  - title: NHS SEQF
    url: https://github.com/NHSDigital/software-engineering-quality-framework
    hide_icon: false # set to true to hide the external link icon - defaults to false
    opens_in_new_tab: false # set to true to open this link in a new tab - defaults to false

callouts:
  warning:
    title: Warning
    color: red
  note:
    title: Warning
    color: blue

# Exclude from processing.
# The following items will not be processed, by default.
# Any item listed under the `exclude:` key here will be automatically added to
# the internal "default list".
#
# Excluded items can be processed by explicitly listing the directories or
# their entries' file path in the `include:` list.
#
include:
  - .version
  - version.json
exclude:
  - package-lock.json
  - package.json
  - Makefile
#   - .sass-cache/
#   - .jekyll-cache/
#   - gemfiles/
#   - Gemfile
#   - Gemfile.lock
#   - node_modules/
#   - vendor/bundle/
#   - vendor/cache/
#   - vendor/gems/
#   - vendor/ruby/