<commit_before>#Login Cidadão Docs

This is the official repository of Login Cidadão Documentation. Here, you can find docs about installation, maintenance mode and procedures of [Projeto Login Cidadão](https://github.com/PROCERGS/login-cidadao).

All documents here were generated with mkdocs.

## How to get this documentation?

1 - In a distro gnu/linux using apt package manager, install the package management system of python language (pip). Sudo user or root permissions can be required:
```
  # apt-get install python-pip
```

2 - After that, as sudo user too, run pip to install mkdocs:
```
  # pip install mkdocs
```

3 - Clone the repo using git (sudo or root permission is not necessary):
```
  $ git clone https://github.com/PROCERGS/login-cidadao-docs.git
```

4 - Done! All content files will be in docs directory.

## How to get a local installation?

1 - After clone the repo, get the diretory and run mkdocs:

```
$ cd login-cidadao-docs
$ mkdocs serve
```

2 - In localhost plus default door (http://127.0.0.1:8000) you can reach the docs site. If you want to make some changes, mkdocs will be able to show automaticaly.

## Building html/css/js

1 - To deploy the docs into a html struture, let's build the documentation. Is very simple. In the zup-docs directory, run mkdocs build:
<commit_msg>Fix path to build docs at readme<commit_after>#Login Cidadão Docs

This is the official repository of Login Cidadão Documentation. Here, you can find docs about installation, maintenance mode and procedures of [Projeto Login Cidadão](https://github.com/PROCERGS/login-cidadao).

All documents here were generated with mkdocs.

## How to get this documentation?

1 - In a distro gnu/linux using apt package manager, install the package management system of python language (pip). Sudo user or root permissions can be required:
```
  # apt-get install python-pip
```

2 - After that, as sudo user too, run pip to install mkdocs:
```
  # pip install mkdocs
```

3 - Clone the repo using git (sudo or root permission is not necessary):
```
  $ git clone https://github.com/PROCERGS/login-cidadao-docs.git
```

4 - Done! All content files will be in docs directory.

## How to get a local installation?

1 - After clone the repo, get the diretory and run mkdocs:

```
$ cd docs
$ mkdocs serve
```

2 - In localhost plus default door (http://127.0.0.1:8000) you can reach the docs site. If you want to make some changes, mkdocs will be able to show automaticaly.

## Building html/css/js

1 - To deploy the docs into a html struture, let's build the documentation. Is very simple. In the zup-docs directory, run mkdocs build:

{'fraction_non_alphanumeric': 0.0857685009487666, 'fraction_numerical': 0.012903225806451613, 'mean_word_length': 3.8905380333951762, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 4, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 2, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7434659', 'n_tokens_mistral': 808, 'n_tokens_neox': 762, 'n_words': 370}