MkDocs Documentation

[activivan]

Supersedes #508 and #21

After struggling with signing my old commits, this is the new pull request for the MkDocs Documentation
https://squidfunk.github.io/mkdocs-material/

[datamweb]

Wait for @kenjis to confirm before applying.

[datamweb]

Can you fix this issue?

[activivan]

This seems to have fixed it

[datamweb]

This seems to have fixed it

Thanks, LGTM!

[kenjis]

$ pip3 install mkdocs
$ pip3 install mkdocs-material
$ mkdocs --version
mkdocs, version 1.4.2 from /usr/local/lib/python3.10/site-packages/mkdocs (Python 3.10)
$ mkdocs build
$ mkdocs serve

[kenjis]

LGTM! 👍

[MGatner]

Awesome! Very cool to have, thanks @activivan

[datamweb]

@activivan Thanks for this PR.

@lonnieezell Please check here, if possible, create a subdomain.

[kenjis]

Something wrong with GitHub Pages:
https://kenjis.github.io/codeigniter-shield/

$ mkdocs gh-deploy --force
INFO     -  Cleaning site directory
INFO     -  Building documentation to directory: /Users/kenji/work/codeigniter/official/codeigniter-shield/site
INFO     -  Documentation built in 1.10 seconds
WARNING  -  Version check skipped: No version specified in previous deployment.
INFO     -  Copying '/Users/kenji/work/codeigniter/official/codeigniter-shield/site' to 'gh-pages' branch and
            pushing to GitHub.
Enumerating objects: 81, done.
Counting objects: 100% (81/81), done.
Delta compression using up to 4 threads
Compressing objects: 100% (65/65), done.
Writing objects: 100% (81/81), 532.13 KiB | 2.21 MiB/s, done.
Total 81 (delta 15), reused 0 (delta 0), pack-reused 0
remote: Resolving deltas: 100% (15/15), done.
remote: 
remote: Create a pull request for 'gh-pages' on GitHub by visiting:
remote:      https://github.com/kenjis/codeigniter-shield/pull/new/gh-pages
remote: 
To github.com:kenjis/codeigniter-shield.git
 * [new branch]      gh-pages -> gh-pages
INFO     -  Your documentation should shortly be available at: https://kenjis.github.io/codeigniter-shield/

[kenjis]

I pushed gh-pages branch.

$ mkdocs gh-deploy --force
INFO     -  Cleaning site directory
INFO     -  Building documentation to directory: /Users/kenji/work/codeigniter/tmp/shield/site
INFO     -  Documentation built in 0.71 seconds
WARNING  -  Version check skipped: No version specified in previous deployment.
INFO     -  Copying '/Users/kenji/work/codeigniter/tmp/shield/site' to 'gh-pages' branch and pushing to GitHub.
Enumerating objects: 81, done.
Counting objects: 100% (81/81), done.
Delta compression using up to 4 threads
Compressing objects: 100% (65/65), done.
Writing objects: 100% (81/81), 532.13 KiB | 2.60 MiB/s, done.
Total 81 (delta 15), reused 3 (delta 0), pack-reused 0
remote: Resolving deltas: 100% (15/15), done.
remote: 
remote: Create a pull request for 'gh-pages' on GitHub by visiting:
remote:      https://github.com/codeigniter4/shield/pull/new/gh-pages
remote: 
To github.com:codeigniter4/shield.git
 * [new branch]      gh-pages -> gh-pages
INFO     -  Your documentation should shortly be available at: https://codeigniter4.github.io/shield/

[kenjis]

I set the GitHub Pages branch.
Okay, no problem.
https://codeigniter4.github.io/shield/

[datamweb]

Thanks❤️