Skip to content

Commit c358ee0

Browse files
RossBugginsNHSRossBugginsNHS
authored
Merge pull request #3 from NHSDigital/CCM-5294-setup-jekyll-for-web-cms
Initial layout.
2 parents a0daaf6 + 5172555 commit c358ee0

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+417
-2715
lines changed

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# NHS Notify Repository Template
1+
# NHS Notify Web CMS Repository
22

33
[![CI/CD Pull Request](https://github.com/nhs-england-tools/repository-template/actions/workflows/cicd-1-pull-request.yaml/badge.svg)](https://github.com/nhs-england-tools/repository-template/actions/workflows/cicd-1-pull-request.yaml)
44
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=repository-template&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=repository-template)
@@ -16,7 +16,7 @@ Make use of this repository template to expedite your project setup and enhance
1616

1717
## Table of Contents
1818

19-
- [NHS Notify Repository Template](#nhs-notify-repository-template)
19+
- [NHS Notify Web CMS Repository](#nhs-notify-web-cms-repository)
2020
- [Table of Contents](#table-of-contents)
2121
- [Documentation](#documentation)
2222
- [Setup](#setup)

‎docs/.gitignore‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
_site
2+
.sass-cache
3+
.jekyll-cache
4+
.jekyll-metadata
5+
vendor
6+
Gemfile.lock

‎docs/404.html‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
permalink: /404.html
3+
layout: default
4+
---
5+
6+
<style type="text/css" media="screen">
7+
.container {
8+
margin: 10px auto;
9+
max-width: 600px;
10+
text-align: center;
11+
}
12+
h1 {
13+
margin: 30px 0;
14+
font-size: 4em;
15+
line-height: 1;
16+
letter-spacing: -1px;
17+
}
18+
</style>
19+
20+
<div class="container">
21+
<h1>404</h1>
22+
23+
<p><strong>Page not found :(</strong></p>
24+
<p>The requested page could not be found.</p>
25+
</div>

‎docs/Gemfile‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
source "https://rubygems.org"
2+
# Hello! This is where you manage which Jekyll version is used to run.
3+
# When you want to use a different version, change it below, save the
4+
# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
5+
#
6+
# bundle exec jekyll serve
7+
#
8+
# This will help ensure the proper Jekyll version is running.
9+
# Happy Jekylling!
10+
gem "jekyll", "~> 4.3.3"
11+
# This is the default theme for new Jekyll sites. You may change this to anything you like.
12+
gem "minima", "~> 2.5"
13+
# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
14+
# uncomment the line below. To upgrade, run `bundle update github-pages`.
15+
# gem "github-pages", group: :jekyll_plugins
16+
# If you have any plugins, put them here!
17+
group :jekyll_plugins do
18+
gem "jekyll-feed", "~> 0.12"
19+
gem "jekyll-drawio"
20+
end
21+
22+
# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
23+
# and associated library.
24+
platforms :mingw, :x64_mingw, :mswin, :jruby do
25+
gem "tzinfo", ">= 1", "< 3"
26+
gem "tzinfo-data"
27+
end
28+
29+
# Performance-booster for watching directories on Windows
30+
gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]
31+
32+
# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem
33+
# do not have a Java counterpart.
34+
gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]
35+
36+
gem "just-the-docs"

‎docs/README.md‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

infrastructure/environments/.gitkeep renamed to docs/_collections/.gitkeep

File renamed without changes.

‎docs/_config.yml‎

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
# Welcome to Jekyll!
2+
#
3+
# This config file is meant for settings that affect your whole blog, values
4+
# which you are expected to set up once and rarely edit after that. If you find
5+
# yourself editing this file very often, consider using Jekyll's data files
6+
# feature for the data you need to update frequently.
7+
#
8+
# For technical reasons, this file is *NOT* reloaded automatically when you use
9+
# 'bundle exec jekyll serve'. If you change this file, please restart the server process.
10+
#
11+
# If you need help with YAML syntax, here are some quick references for you:
12+
# https://learn-the-web.algonquindesign.ca/topics/markdown-yaml-cheat-sheet/#yaml
13+
# https://learnxinyminutes.com/docs/yaml/
14+
#
15+
# Site settings
16+
# These are used to personalize your new site. If you look in the HTML files,
17+
# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
18+
# You can create any custom variable you would like, and they will be accessible
19+
# in the templates via {{ site.myvariable }}.
20+
21+
title: NHS Notify CMS
22+
# email: [email protected]
23+
description: >- # this means to ignore newlines until "baseurl:"
24+
NHS Notify Web CMS
25+
baseurl: "/nhs-notify-web-cms" # the subpath of your site, e.g. /blog
26+
url: "https://nhsdigital.github.io" # the base hostname & protocol for your site, e.g. http://example.com
27+
28+
collections_dir: _collections
29+
30+
collections:
31+
notify-repos:
32+
output: true
33+
sort_by: order
34+
35+
# Build settings
36+
theme: just-the-docs
37+
plugins:
38+
- jekyll-feed
39+
40+
color_scheme: nhs
41+
mermaid:
42+
# Version of mermaid library
43+
# Pick an available version from https://cdn.jsdelivr.net/npm/mermaid/
44+
version: "10.9.1"
45+
46+
aux_links:
47+
"NHS Notify on GitHub":
48+
- "//github.com/NHSDigital/nhs-notify"
49+
50+
aux_links_new_tab: false
51+
52+
# Footer "Edit this page on GitHub" link text
53+
gh_edit_link: true # show or hide edit this page link
54+
gh_edit_link_text: "Edit this page on GitHub."
55+
gh_edit_repository: "https://github.com/NHSDigital/nhs-notify" # the github URL for your repo
56+
gh_edit_branch: "main" # the branch that your docs is served from
57+
# gh_edit_source: docs # the source that your files originate from
58+
gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately
59+
60+
nav_external_links:
61+
- title: Notify Service Catalogue
62+
url: https://digital.nhs.uk/services/nhs-notify
63+
hide_icon: false # set to true to hide the external link icon - defaults to false
64+
opens_in_new_tab: false # set to true to open this link in a new tab - defaults to false
65+
66+
callouts:
67+
warning:
68+
title: Warning
69+
color: red
70+
71+
# Exclude from processing.
72+
# The following items will not be processed, by default.
73+
# Any item listed under the `exclude:` key here will be automatically added to
74+
# the internal "default list".
75+
#
76+
# Excluded items can be processed by explicitly listing the directories or
77+
# their entries' file path in the `include:` list.
78+
#
79+
# exclude:
80+
# - .sass-cache/
81+
# - .jekyll-cache/
82+
# - gemfiles/
83+
# - Gemfile
84+
# - Gemfile.lock
85+
# - node_modules/
86+
# - vendor/bundle/
87+
# - vendor/cache/
88+
# - vendor/gems/
89+
# - vendor/ruby/

infrastructure/images/.gitkeep renamed to docs/_includes/.gitkeep

File renamed without changes.

‎docs/_includes/search/input.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<input type="text" id="docsearch-input" placeholder="Search the docs…" aria-label="Search">

infrastructure/modules/.gitkeep renamed to docs/_layouts/.gitkeep

File renamed without changes.

0 commit comments

Comments
 (0)