Skip to content

Commit

Permalink
Feature/docs basic entries (#123)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
GaProgMan authored Nov 28, 2024
1 parent 3e8e3cd commit 6f049b8
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/configuration/Strict-Transport-Security.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
1 change: 1 addition & 0 deletions docs/configuration/X-Content-Type-Options.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
1 change: 1 addition & 0 deletions docs/configuration/X-Frame-Options.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
1 change: 1 addition & 0 deletions docs/configuration/X-XSS-Protection.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
1 change: 1 addition & 0 deletions docs/configuration/index.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down

0 comments on commit 6f049b8

Please sign in to comment.