Code Monkey home page Code Monkey logo

nhs-login-help-centre's Introduction

NHS Help Centre

Help pages for lost users

Setup

  • npm install
  • npm start
  • npm build to build

Deployment

This repo is automatically deployed when code is merged to master. Deployment code is located in .github/workflows/11ty-build.yml.

Structure

File structure is as follows:

  • /src/index.njk: Main hub page, lists all pages with the categories tag
  • /src/**/index.md: Category list pages, most of the heavy lifting is done in /src/_include/layouts/category-index.njk
  • /src/**/*.md: Articles, most of the heavy lifting is done in /src/_include/layouts/category-page.njk
  • /src/images, /src/css, /src/js asset folders

Hub pages

These pages are nested version of the main hub used for navigation They require the following keys and no content:

  • title: Page title
  • subtitle: A description of the Hub
  • pageName: The page name sent to analytics, minus "nhs:cid:help-centre:", should be all lowercase with dashes
  • name: the id of the hub
  • type: Always hub
  • layout: Always layouts/hub.njk
  • hub: the name of the parient hub page (home for the home page)
  • position: determines the position on the parient hub page

Article pages

These pages place their content in the artcle page template that generates related the sidemenu and breadcrumbs They require the following keys:

  • title: Page title
  • subtitle: A description of the page
  • pageName: The page name sent to analytics, minus "nhs:cid:help-centre:", should be all lowercase with dashes
  • type: Always article
  • hub: The Hub page that the article page will appear on
  • position: The position on the hub page
  • layout: Always layouts/article.njk

Useful links

The 11ty is as of writing fairly poor, heres some links to help:

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.