From 6f049b849e77a63f9115b07419af0b6cfe26c18c Mon Sep 17 00:00:00 2001 From: Jamie Taylor <1607732+GaProgMan@users.noreply.github.com> Date: Thu, 28 Nov 2024 16:30:31 +0000 Subject: [PATCH] Feature/docs basic entries (#123) * Re-arranged basic docs, added configuration page * Altered ordering of pages * Added changelog to docs * Added about header to index * Removed reference to code base * Added quote type to docs config * Made configuration docs into a directory * Added HSTS and X-Frame-Options docs * Added empty CSP docs file * Added docs for the X-Content-Type-Options header * Added docs for the X-XSS-Protection header * Linked to the CSP header docs in the X-Frame-Options header * Fixed layout types on header config docs --- docs/configuration/Strict-Transport-Security.md | 1 + docs/configuration/X-Content-Type-Options.md | 1 + docs/configuration/X-Frame-Options.md | 1 + docs/configuration/X-XSS-Protection.md | 1 + docs/configuration/index.md | 1 + 5 files changed, 5 insertions(+) diff --git a/docs/configuration/Strict-Transport-Security.md b/docs/configuration/Strict-Transport-Security.md index a895654..b0aeeb3 100644 --- a/docs/configuration/Strict-Transport-Security.md +++ b/docs/configuration/Strict-Transport-Security.md @@ -1,6 +1,7 @@ --- title: Strict-Transport-Security (HSTS) nav_order: 1 +layout: page --- The Mozilla Developer Network describes the Strict-Transport-Security header like this: diff --git a/docs/configuration/X-Content-Type-Options.md b/docs/configuration/X-Content-Type-Options.md index 7fd996e..ec5ecca 100644 --- a/docs/configuration/X-Content-Type-Options.md +++ b/docs/configuration/X-Content-Type-Options.md @@ -1,6 +1,7 @@ --- title: X-Content-Type-Options nav_order: 4 +layout: page --- The Mozilla Developer Network describes the X-Content-Type-Options header like this: diff --git a/docs/configuration/X-Frame-Options.md b/docs/configuration/X-Frame-Options.md index 80a2fd7..e7ccc3e 100644 --- a/docs/configuration/X-Frame-Options.md +++ b/docs/configuration/X-Frame-Options.md @@ -1,6 +1,7 @@ --- title: X-Frame-Options (XFO) nav_order: 2 +layout: page --- The Mozilla Developer Network describes the X-Frame-Options header like this: diff --git a/docs/configuration/X-XSS-Protection.md b/docs/configuration/X-XSS-Protection.md index 3b98b12..ca06402 100644 --- a/docs/configuration/X-XSS-Protection.md +++ b/docs/configuration/X-XSS-Protection.md @@ -1,6 +1,7 @@ --- title: X-XSS-Protection nav_order: 3 +layout: page --- The Mozilla Developer Network describes the X-XSS-Protection header like this: diff --git a/docs/configuration/index.md b/docs/configuration/index.md index ed0764e..df58f03 100644 --- a/docs/configuration/index.md +++ b/docs/configuration/index.md @@ -1,6 +1,7 @@ --- title: Configuration nav_order: 2 +layout: page --- This Middleware uses the builder pattern to set up the header information, which is a compile time dependency. If you need to change the configuration, you will need to rebuild your application.