Merge pull request #513 from activivan/develop

datamweb · web-flow · commit 4dc315b886a4 · 2022-11-09T14:37:56.000+03:30
MkDocs Documentation
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -0,0 +1,15 @@
+name: docs 
+on:
+  push:
+    branches:
+      - master
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: 3.x
+      - run: pip install mkdocs-material 
+      - run: mkdocs gh-deploy --force
diff --git a/.gitignore b/.gitignore
@@ -6,3 +6,4 @@ phpunit
 composer.lock
 .DS_Store
 .idea/
+site
diff --git a/docs/assets/favicon.ico b/docs/assets/favicon.ico
diff --git a/docs/assets/flame.svg b/docs/assets/flame.svg
@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg width="100%" height="100%" viewBox="0 0 23 29" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" xmlns:serif="http://www.serif.com/" style="fill-rule:evenodd;clip-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:2;">
+    <g transform="matrix(1,0,0,1,-0.000132366,2.84217e-14)">
+        <g transform="matrix(1,0,0,1,-217.724,-305.191)">
+            <g transform="matrix(1,0,0,1,211.893,297.173)">
+                <path d="M13.142,36.168C11.335,35.37 10.107,33.65 9.946,31.681C10.052,29.655 11.122,27.804 12.821,26.699C12.542,27.379 12.61,28.154 12.997,28.776C13.438,29.392 14.197,29.688 14.939,29.534C15.997,29.236 16.617,28.138 16.319,27.079C16.214,26.709 16.002,26.373 15.714,26.119C14.517,25.146 13.916,23.617 14.13,22.088C14.335,21.278 14.783,20.546 15.416,19.994C14.94,21.261 16.281,22.511 17.18,23.126C18.776,24.084 20.313,25.136 21.784,26.278C23.392,27.545 24.268,29.528 24.131,31.558C23.769,33.717 22.242,35.5 20.16,36.169C24.325,35.242 28.619,31.933 28.701,27.24C28.619,23.485 26.378,20.116 22.952,18.581L22.8,18.581C22.875,18.765 22.912,18.963 22.905,19.163C22.917,19.034 22.917,18.905 22.905,18.776C22.924,18.928 22.924,19.081 22.905,19.233C22.645,20.301 21.568,20.958 20.498,20.698C20.07,20.592 19.688,20.352 19.413,20.005C18.041,18.245 19.413,16.242 19.643,14.306C19.784,11.831 18.653,9.464 16.647,8.018C17.651,9.691 16.313,11.89 15.341,13.14C14.367,14.391 12.959,15.323 11.811,16.414C10.575,17.564 9.441,18.828 8.424,20.18C6.225,22.867 5.362,26.411 6.077,29.807C7.058,33.081 9.779,35.541 13.135,36.179L13.153,36.179L13.142,36.168Z" style="fill:white;fill-rule:nonzero;"/>
+            </g>
+        </g>
+    </g>
+</svg>
diff --git a/docs/assets/hljs.js b/docs/assets/hljs.js
@@ -0,0 +1,3 @@
+document.addEventListener('DOMContentLoaded', (event) => {
+    hljs.highlightAll();
+});
diff --git a/docs/concepts.md b/docs/concepts.md
@@ -32,8 +32,6 @@ The only requirement is that your new class MUST extend the provided `UserModel`
 public $userProvider = 'CodeIgniter\Shield\Models\UserModel';
 ```
 
-<a name="identities" />
-
 ## User Identities
 
 User accounts are stored separately from the information needed to identify that user. These identifying pieces of data are
diff --git a/docs/index.md b/docs/index.md
@@ -10,6 +10,6 @@
 * [Testing](testing.md)
 * [Customization](customization.md)
 
-Guides:
+## Guides
 * [Protecting an API with Access Tokens](guides/api_tokens.md)
 * [Mobile Authentication with Access Tokens](guides/mobile_apps.md)
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,53 @@
+site_name: CodeIgniter Shield
+site_description: Documentation for the official Authentication and Authorization framework for CodeIgniter 4
+
+theme:
+  name: material
+  logo: assets/flame.svg
+  favicon: assets/favicon.ico
+  icon:
+    repo: fontawesome/brands/github
+  font:
+    text: Raleway
+  palette:
+    primary: deep orange
+  features:
+    - navigation.sections
+
+extra:
+  homepage: https://codeigniter.com
+
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/codeigniter4/shield
+      name: GitHub
+
+repo_url: https://github.com/codeigniter4/shield
+
+markdown_extensions:
+  - pymdownx.superfences
+  - pymdownx.highlight:
+      use_pygments: false
+
+extra_css:
+  - https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.6.0/build/styles/github.min.css
+
+extra_javascript:
+  - https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.6.0/build/highlight.min.js
+  - assets/hljs.js
+
+nav:
+  - Home: index.md
+  - Installation: install.md
+  - Concepts: concepts.md
+  - Quick Start Guide: quickstart.md
+  - Authentication: authentication.md
+  - Authorization: authorization.md
+  - Auth Actions: auth_actions.md
+  - Events: events.md
+  - Testing: testing.md
+  - Customization: customization.md
+  - session_auth_event_and_logging.md
+  - Guides:
+    - guides/api_tokens.md
+    - guides/mobile_apps.md

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+document.addEventListener('DOMContentLoaded', (event) => {`
	`2`	`+ hljs.highlightAll();`
	`3`	`+});`