Guía para la documentación

Crear un documento

Acá hay que explicar como crear un documento (Id y Title). El Id no puede contener la palabra Agent ni Environment

Modificar el índice

Acá hay que explicar como gestionar el índice

Headings (títulos)

Hay 4 niveles de Heading: H2, H3, H4 y H5. Se utilizan # (hashtags) para indicar los diferente niveles de Heading. Los Headings 2 y 3 aparecen en la sección de navegación del documento (a la derecha).

## Heading 2 <H2> 
### Heading 3 <H3>
#### Heading 4 <H4>
##### Heading 5 <H5>

Resaltar texto

*Esto es un texto en cursiva*
_Esto es otro texto en cursiva_

**Esto es un texto en negrita**
__Esto es otro texto en negrita__

_Se **pueden** combinar_

Listas

Viñetas

* Item 1
* Item 2
    * Item 2a
    * Item 2b

Numeradas

1. Item 1
1. Item 2
1. Item 3
    1. Item 3a
    1. Item 3b

Notas

Para escribir una nota se debe empezar el párrafo con el símobo '>'

> Nota: Esto es una nota

Imágenes

Las imágenes deben ser colocadas en la carpeta /website/assets. De ser necesario se deben colocar las imágenes en las carpetas correspondientes a los idiomas.

![](/assets/en/SetupAndConfiguration_16.png)

Importante: colocar un width 100% en aquellas imagenes muy anchas para que IE11 las ajuste. En el resto de los browsers funciona bien. Pero en IE11 genera un scroll feo.

Iconos

Para agregar íconos en linea con el texto se utiliza la librería de íconos Font Awesome. Para agregar un ícono se debe utilizar el tag HTML específico de está librería.

Esto es un texto con un ícono <i class="fas fa-lock"></i> en linea

Tablas

**Columna 1** | **Columna 2**
------------- | ---------------
Fila 1 Columna 1 | Fila 1 Columna 2
Fila 2 Columna 1 | Fila 2 Columna 2

Código fuente

En linea con el texto

Para agregar código dentro de una línea se debe encerrar el código entre el caracter `.

Ejemplo para marcar `código fuente` en linea con el texto

Resalta sintaxis para un lenguaje

Para agregar un bloque con sintaxis resaltada se deben colocar los caracteres ``` al principio y final del bloque.

```
SELECT * FROM MyTable
SELECT * FROM MyOtherTable
```

Sin resaltar sintaxis

Si no se desea marcar con colores la sintaxis del código pero sí definir un bloque separado se deben utilizar 4 espacios delante de cada linea de código.

    SELECT * FROM MyTable
    SELECT * FROM MyOtherTable

Lineas horizontales

Se puede agregar una linea horizontal que cruce todo el documento

---

Links

Links directos

Si se coloca una URL directamente en el texto, automáticamente se traducirá a un Link.

https://www.botready.net

Links con nombre

Si se desea colocar un link pero con un texto diferente se debe utilizar la siguiente sintáxis

[BotReady](https://www.botready.net)