Documentação

Este site foi criado usando o mkdocs.

Criar sites de documentação com MkDocs de forma simples usando markdown e ele exporta (build) em HTML.

Site oficial

https://www.mkdocs.org/

Instalação

https://www.mkdocs.org/#installation

Instalação no Linux Mint 20

sudo apt update
sudo apt-get install python3
sudo apt-get install python3-pip
sudo pip3 install mkdocs
sudo pip3 install mkdocs-material

Criar um site de documentação

Acessar o terminal/prompt e executar para criar o site na pasta docs

1	`mkdocs new docs`

O comando acima criou a estrutura:

mkdocs.yml
/docs/
    index.md

cd docs

mkdocs serve

http://127.0.0.1:8000/

Exemplo de site. Este site da documentação do laravel-acl

Configuraçõe a serem usadas no mkdocs.yml

https://www.mkdocs.org/user-guide/configuration

Editar o mkdocs.yml e deixar assim:

site_name: ACL to Laravel 7
theme:
  name: 'readthedocs'
  favicon: 'img/favicon.ico'
site_url: https://ribafs.github.io/
repo_url: https://github.com/ribafs/laravel-acl/
site_description: ACL Implementation to Laravel 7
site_author: Ribamar FS
nav:
    - Início: index.md
    - Introdução: introduction.md
    - Instalação: installation.md
    - Bootstrap: bootstrap.md
    - Controllers: controllers.md
    - Views: views.md 
    - Rotas: routes.md
    - Seeders: seeders.md
    - Middleware: middleware.md
    - Provider: provider.md
    - Trait: trait.md
    - Tinker: tinker.md
    - Gerenciando: manager.md
    - Customizações: customizations.md
    - Testando: training.md
    - Erros: errors.md
    - Documentação: documentation.md
    - Licença: license.md
    - Referências: references.md
    - Testando: training.md
    - Créditos: credits.md

Editar o index.md e deixar assim:

- ## ACL no Laravel 7
    - [Introdução](introduction.md)
    - [Instalação](installation.md)
    - [BootStrap](bootstrap.md)
    - [Controllers](controllers.md)
    - [Views](views.md)
    - [Middleware](middleware.md)
    - [Provider](provider.md)
    - [Trait](trait.md)
    - [Seeders](seeders.md) 
    - [Gerenciando](manager.md)
    - [Tinker](tinker.md)
    - [Testando o ACL](training.md)
    - [Customizando](customizations.md)
    - [Erros](errors.md)
    - [Documentação](documentation.md)
    - [Referências](references.md)
    - [Créditos](credits.md)
    - [Licença](license.md)

O index.md mostrará seu conteúdo no painel d a direita quando clicamos em Início.

Agora basta criar cada um dos arquivos com a estensão .md. Exemplo:

introduction.md

# Introdução

---

- [Seção Inicial](#section-1)

<a name="section-1"></a>
## Seção Inicial

Projeto de implementação de ACL em aplicativos do Laravel from Scratch

Usando Users, Roles, Permissions, Provider, Middleware, Trait, Gates, etc

Observação: este projeto é fruto de várias pesquisas pela internet e de alguns experimentos meus

Conta com três versões
- laravel-acl - para o laravel 8
- laravel7-acl - para o laravel 7
- laravel58-acl - para o laravel 5.8
...