Migrate to MkDocs

roboticslab-uc3m/questions-and-answers#99

Author: PeterBowman

.gitbook.yaml

@@ -0,0 +1,25 @@
+name: GitHub Pages
+
+on:
+  push:
+    branches:
+    - master
+    paths:
+    - docs/**
+    - mkdocs.yml
+  workflow_dispatch:
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: fkirc/skip-duplicate-actions@v5
+      with:
+        cancel_others: 'true'
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0 # for the 'Last updated' timestamp
+    - name: Install requirements
+      run: pip install -r requirements.txt
+    - name: Build and deploy site
+      run: mkdocs gh-deploy --no-history

.github/workflows/gh-pages.yml

@@ -6,6 +6,5 @@
 *.swp
 *.orig
 
-## gitbook generated
-/_book/
-/node_modules/
+## mkdocs generated
+/site/

.github/workflows/gitbook.yml

@@ -1,15 +1,15 @@
-[![asrob-uc3m logo](assets/asrob-135x135.png)](https://asrob.uc3m.es)
+[![asrob-uc3m logo](docs/assets/asrob-135x135.png)](https://asrob.uc3m.es)
 
 # Tutoriales
 
-Recopilación de tutoriales y materiales útiles sobre los programas y herramientas que usamos en [ASROB](https://asrob.uc3m.es)
+Recopilación de tutoriales y materiales útiles sobre los programas y herramientas que usamos en [ASROB](https://asrob.uc3m.es).
 
 Actualmente alojado en: https://asrob.uc3m.es/tutoriales
 
 ## Si tienes alguna duda o comentario con respecto al contenido
 
 1. Por favor revisa si puedes encontrar la respuesta en el archivo correspondiente y/o en la documentación de la carpeta a la cual pertenece, así como en la sección [Issues](https://github.com/asrob-uc3m/tutoriales/issues) (problemas abiertos y cerrados).
-2. Si tu duda o comentario no es un duplicado, comenta de forma pública detalladamente: [Nueva Issue](https://github.com/asrob-uc3m/tutoriales/issues/new)
+2. Si tu duda o comentario no es un duplicado, comenta de forma pública detalladamente: [Nueva Issue](https://github.com/asrob-uc3m/tutoriales/issues/new).
 
 ## Cómo hacer
 * [Cómo servir en localhost](#cómo-servir-servir-en-localhost)
@@ -18,16 +18,17 @@ Actualmente alojado en: https://asrob.uc3m.es/tutoriales
 ### Cómo servir en localhost
 Es útil servir en `localhost` para modificar el sitio web y ver los cambios localmente.
 
-1. Desde la raíz del proyecto, ejecuta el siguiente comando (que es universal para todos los proyectos basados en [Gitbook (legacy)](https://github.com/GitbookIO/gitbook)):
+1. Desde la raíz del proyecto, ejecuta el siguiente comando:
 ```bash
-gitbook serve # command builds and serves
+pip install -r requirements.txt
+mkdocs serve
 ```
 
-2. Ahora puedes navegar por el sitio en la ubicación predeterminada: http://127.0.0.1:4000
+2. Ahora puedes navegar por el sitio en la ubicación predeterminada: http://127.0.0.1:8000
 
 ### Cómo subir cambios a GitHub
-Este proyecto se administra como cualquier proyecto en [GitHub](https://www.github.com). Puedes usar [Git](https://git-scm.com) o incluso la interfaz web de GitHub, sobre las cuales puedes encontrar muchos tutoriales online. Los siguientes puntos son específicos del mecanismo [Gitbook (legacy)](https://github.com/asrob-uc3m/actas/issues/148#issuecomment-449748350) utilizado y su [configuración actual](https://github.com/asrob-uc3m/robotDevastation-user-manual/settings):
+Este proyecto se administra como cualquier proyecto en [GitHub](https://www.github.com). Puedes usar [Git](https://git-scm.com) o incluso la interfaz web de GitHub, sobre las cuales puedes encontrar muchos tutoriales online. Los siguientes puntos son específicos del mecanismo MkDocs:
 
-1. Por favor **no subas** la carpeta `_book/`. Se genera automáticamente a nivel local, y lo mismo debería ocurrir en los servidores de Gitbook (legacy).
+1. Por favor **no subas** la carpeta `site/`. Se genera automáticamente a nivel local, y lo mismo debería ocurrir en los servidores de MkDocs.
 
 2. Se puede `git push` a cualquier branch upstream, pero recuerda que lo que está en `master` es lo que realmente se renderizará como el sitio web.

.gitignore

@@ -2,14 +2,14 @@
 
 # Tutoriales
 
-Recopilación de tutoriales y materiales útiles sobre los programas y herramientas que usamos en [ASROB](https://asrob.uc3m.es)
+Recopilación de tutoriales y materiales útiles sobre los programas y herramientas que usamos en [ASROB](https://asrob.uc3m.es).
 
-Pincha en la opción que quieras, o utiliza las flechas para avanzar secuencialmente
+Pincha en la opción que quieras, o utiliza las teclas P y N para avanzar secuencialmente (P: anterior, N: siguiente).
 
 ## Notas adicionales
 
-El contenido de esta documentación se genera a partir de ficheros alojados en: <https://github.com/asrob-uc3m/tutoriales>
+El contenido de esta documentación se genera a partir de ficheros alojados en: <https://github.com/asrob-uc3m/tutoriales>.
 
 ## Si tienes dudas con respecto al contenido
 
-Por favor comenta de forma pública [AQUÍ](https://github.com/asrob-uc3m/tutoriales/issues/new)
+Por favor comenta de forma pública [AQUÍ](https://github.com/asrob-uc3m/tutoriales/issues/new).

README.md

@@ -75,37 +75,34 @@ Se deben conectar los bornes de la batería a los bornes marcados como OUTPUT en
 
 Al encenderse, el cargador mostrará la última configuración utilizada.
 
-1.Pulsar repetidamente el botón Stop hasta que aparezca esta pantalla:
+1. Pulsar repetidamente el botón Stop hasta que aparezca esta pantalla:
+  ![program select lipo batt](https://user-images.githubusercontent.com/6171234/31885092-a046e156-b7ef-11e7-89ee-b229a7e823eb.PNG)
 
-![program select lipo batt](https://user-images.githubusercontent.com/6171234/31885092-a046e156-b7ef-11e7-89ee-b229a7e823eb.PNG)
+2. Pulsar el botón Enter, se mostrarán las opciones de carga o descarga:
+  ![lipo options](https://user-images.githubusercontent.com/6171234/31885133-c4e54282-b7ef-11e7-8169-627c724361f8.PNG)
 
-2.Pulsar el botón Enter, se mostrarán las opciones de carga o descarga:
+3. Pulsar los botones izquierda o derecha para navegar entre las opciones:
+    - CHARGE: Carga completa, sin utilizar el conector de equilibrado.
+    - BALANCE: Carga completa y equilibrada, requiere conectar el conector de equilibrado.
+    - FAST CHG: Carga rápida, incompleta, sin utilizar el conector de equilibrado.
+    - STORAGE: Carga o descarga equilibrada hasta la tensión óptima de almacenamiento. Útil si se va a tener la batería mucho tiempo sin utilizar.
+    - DISCHARGE: Descarga completa de la batería.
 
-![lipo options](https://user-images.githubusercontent.com/6171234/31885133-c4e54282-b7ef-11e7-8169-627c724361f8.PNG)
+    **Atención**: Se recomienda utillizar únicamente las opciones BALANCE y STORAGE, por ser las más respetuosas con la batería. Las otras opciones pueden comprometer su vida útil y su seguridad. En esta guía se describe el proceso de carga mediante la opción BALANCE. Para otras opciones consultar el [manual de usuario](https://github.com/asrob-uc3m/actas/files/1397540/iMAXB6ACmanual.pdf).
 
-3.Pulsar los botones izquierda o derecha para navegar entre las opciones:
+4. Una vez se encuentre en la pantalla la opción BALANCE, pulsar Enter. Parpadeará la corriente.
 
-  - CHARGE: Carga completa, sin utilizar el conector de equilibrado.
-  - BALANCE: Carga completa y equilibrada, requiere conectar el conector de equilibrado.
-  - FAST CHG: Carga rápida, incompleta, sin utilizar el conector de equilibrado.
-  - STORAGE: Carga o descarga equilibrada hasta la tensión óptima de almacenamiento. Útil si se va a tener la batería mucho tiempo sin utilizar.
-  - DISCHARGE: Descarga completa de la batería.
+5. Ajustar la corriente con los botones izquierda o derecha. Esta corriente será la máxima utilizada durante el proceso de carga; a mayor corriente, mayor velocidad.
 
-**Atención**: Se recomienda utillizar únicamente las opciones BALANCE y STORAGE, por ser las más respetuosas con la batería. Las otras opciones pueden comprometer su vida útil y su seguridad. En esta guía se describe el proceso de carga mediante la opción BALANCE. Para otras opciones consultar el [manual de usuario](https://github.com/asrob-uc3m/actas/files/1397540/iMAXB6ACmanual.pdf).
+    **Precaución**: Para la carga, se recomienda utilizar como máximo un valor de corriente correspondiente a 1C. Un valor de 1C es un valor en corriente igual a la capacidad de la batería. Por ejemplo, para una batería de 2200mAh, un valor de 1C es una corriente de 2,2A. Si no se tiene mucha prisa, se recomienda utilizar valores alrededor de 0,5C.
 
-4.Una vez se encuentre en la pantalla la opción BALANCE, pulsar Enter. Parpadeará la corriente.
+6. Una vez seleccionada la corriente deseada, pulsar Enter. Parpadeará la tensión.
 
-5.Ajustar la corriente con los botones izquierda o derecha. Esta corriente será la máxima utilizada durante el proceso de carga; a mayor corriente, mayor velocidad.
+7. Ajustar la tensión con los botones izquierda o derecha. Esta debe ser la tensión nominal de la batería.
 
-**Precaución**: Para la carga, se recomienda utilizar como máximo un valor de corriente correspondiente a 1C. Un valor de 1C es un valor en corriente igual a la capacidad de la batería. Por ejemplo, para una batería de 2200mAh, un valor de 1C es una corriente de 2,2A. Si no se tiene mucha prisa, se recomienda utilizar valores alrededor de 0,5C.
+8. Mantener pulsado Enter durante 3 segundos. El cargador comprobará la batería conectada.
 
-6.Una vez seleccionada la corriente deseada, pulsar Enter. Parpadeará la tensión.
-
-7.Ajustar la tensión con los botones izquierda o derecha. Esta debe ser la tensión nominal de la batería.
-
-8.Mantener pulsado Enter durante 3 segundos. El cargador comprobará la batería conectada.
-
-9.Se mostrará en pantalla una comparación entre la batería detectada y la batería indicada por el usuario. Si son distintas, pulsar Stop para comprobar la configuración, si son idénticas pulsar Enter y la carga comenzará.
+9. Se mostrará en pantalla una comparación entre la batería detectada y la batería indicada por el usuario. Si son distintas, pulsar Stop para comprobar la configuración, si son idénticas pulsar Enter y la carga comenzará.
 
 ### Proceso de carga LiPo
 
@@ -143,35 +140,33 @@ Se deben conectar los bornes de la batería a los bornes marcados como OUTPUT en
 
 Al encenderse, el cargador mostrará la última configuración utilizada.
 
-1.Pulsar repetidamente el botón Stop hasta que aparezca esta pantalla:
-
-![program select nimh batt](https://user-images.githubusercontent.com/6171234/31885761-f517c8ce-b7f1-11e7-8c24-8d07e11401ab.PNG)
-
-2.Pulsar el botón Enter, se mostrarán las opciones de carga o descarga:
+1. Pulsar repetidamente el botón Stop hasta que aparezca esta pantalla:
 
-![nimh options](https://user-images.githubusercontent.com/6171234/31885770-fa0b8730-b7f1-11e7-9b2f-93c2dbeaad23.PNG)
+    ![program select nimh batt](https://user-images.githubusercontent.com/6171234/31885761-f517c8ce-b7f1-11e7-8c24-8d07e11401ab.PNG)
 
-3.Pulsar los botones izquierda o derecha para navegar entre las opciones:
+2. Pulsar el botón Enter, se mostrarán las opciones de carga o descarga:
+  ![nimh options](https://user-images.githubusercontent.com/6171234/31885770-fa0b8730-b7f1-11e7-9b2f-93c2dbeaad23.PNG)
 
-  - CHARGE: Carga completa de la batería.
-  - DISCHARGE: Descarga completa de la batería.
-  - CYCLE: Ciclos de carga y descarga
+3. Pulsar los botones izquierda o derecha para navegar entre las opciones:
+    - CHARGE: Carga completa de la batería.
+    - DISCHARGE: Descarga completa de la batería.
+    - CYCLE: Ciclos de carga y descarga
 
-**Atención**: En esta guía se describe el proceso de carga mediante la opción CHARGE. Para otras opciones consultar el [manual de usuario](https://github.com/asrob-uc3m/actas/files/1397540/iMAXB6ACmanual.pdf).
+    **Atención**: En esta guía se describe el proceso de carga mediante la opción CHARGE. Para otras opciones consultar el [manual de usuario](https://github.com/asrob-uc3m/actas/files/1397540/iMAXB6ACmanual.pdf).
 
-4.Una vez se encuentre en la pantalla la opción CHARGE, pulsar Enter. Parpadeará el modo.
+4. Una vez se encuentre en la pantalla la opción CHARGE, pulsar Enter. Parpadeará el modo.
 
-5.Ajustar el modo con los botones izquierda o derecha. El modo automático (Aut) permte seleccionar la máxima corriente de carga pero deja libertad al cargador para irla variando durante la carga, mientras que el modo manual (Man) utiliza una corriente de carga fija.
+5. Ajustar el modo con los botones izquierda o derecha. El modo automático (Aut) permte seleccionar la máxima corriente de carga pero deja libertad al cargador para irla variando durante la carga, mientras que el modo manual (Man) utiliza una corriente de carga fija.
 
-6.Una vez seleccionado el modo deseado, pulsar Enter. Parpadeará la corriente.
+6. Una vez seleccionado el modo deseado, pulsar Enter. Parpadeará la corriente.
 
-7.Ajustar la corriente con los botones izquierda o derecha.
+7. Ajustar la corriente con los botones izquierda o derecha.
 
-**Precaución**: Para la carga, se recomienda utilizar como máximo un valor de corriente correspondiente a 0,5C. Un valor de 1C es un valor en corriente igual a la capacidad de la batería. Por ejemplo, para una batería de 2200mAh, un valor de 1C es una corriente de 2,2A; y un valor de 0,5C es una corriente de 1,1A. Si no se tiene mucha prisa, se recomienda utilizar valores alrededor de 0,25C.
+    **Precaución**: Para la carga, se recomienda utilizar como máximo un valor de corriente correspondiente a 0,5C. Un valor de 1C es un valor en corriente igual a la capacidad de la batería. Por ejemplo, para una batería de 2200mAh, un valor de 1C es una corriente de 2,2A; y un valor de 0,5C es una corriente de 1,1A. Si no se tiene mucha prisa, se recomienda utilizar valores alrededor de 0,25C.
 
-**Atención**: Debido a la técnica que utiliza el cargador para reconocer la carga, no se recomienda utilizar corrientes inferiores a 0,2C, ya que el cargador tendrá problemas para reconocer cuándo la batería está completamente cargada. 
+    **Atención**: Debido a la técnica que utiliza el cargador para reconocer la carga, no se recomienda utilizar corrientes inferiores a 0,2C, ya que el cargador tendrá problemas para reconocer cuándo la batería está completamente cargada.
 
-8.Mantener pulsado Enter durante 3 segundos. El cargador comprobará la batería conectada, y en caso afirmativo la carga comenzará.
+8. Mantener pulsado Enter durante 3 segundos. El cargador comprobará la batería conectada, y en caso afirmativo la carga comenzará.
 
 ### Proceso de carga NiMH
 

SUMMARY.md

@@ -2,6 +2,6 @@
 
 KiCad es una aplicación de software libre para de diseño asistido por computadora de circuitos. Facilita el diseño de esquemáticos para circuitos electrónicos y su conversión a placa de circuito impreso.
 
-- Página oficial: http://kicad-pcb.org
-- GitHub: https://github.com/KiCad
+- Página oficial: <http://kicad-pcb.org>
+- GitHub: <https://github.com/KiCad>
 - Algunos vídeo-tutoriales: [en inglés](https://www.youtube.com/playlist?list=PLCNJWVn9MJuORLQ3ds_U3D7RILfE4zdoL)

gitbook-cover.md docs/README.md

@@ -22,8 +22,10 @@ Guía con recomendaciones básicas para soldar:
 
 ## Descripción de elementos
 En la siguiente imagen se indican los dos elementos que forman la estación de soldadura Baku 601D.
-Descripción de controles (de izquierda a derecha)
+Descripción de controles (de izquierda a derecha):
+
 1. Control analógico de la temperatura del soldador.
 2. Control analógico del caudal de aire de la pistola de aire caliente.
 3. Control digital de la temperatura del aire en la pistola de aire caliente.
+
 ![soldering](../assets/photo_2019-02-01_18-08-52.jpg)

ai/README.md docs/ai/README.md

@@ -2,7 +2,7 @@
 
 FreeCAD es una aplicación de software libre para de diseño asistido por computadora en tres dimensiones. Presenta un entorno de trabajo similar a CATIA, SolidWorks, SolidEdge, ArchiCAD o Autodesk Revit.
 
-- Página oficial: https://www.freecadweb.org/
-- GitHub: https://github.com/FreeCAD/FreeCAD
+- Página oficial: <https://www.freecadweb.org/>
+- GitHub: <https://github.com/FreeCAD/FreeCAD>
 - Vídeo-tutoriales de Obijuan: [Temporada 1](https://www.youtube.com/playlist?list=PLmnz0JqIMEzWQV-3ce9tVB_LFH9a91YHf)
 - Vídeo-tutoriales de Obijuan: [Temporada 2](https://www.youtube.com/playlist?list=PLmnz0JqIMEzUqEM-nxqhZoDaqszVXijOb)

assets/asrob-135x135.png docs/assets/asrob-135x135.png

@@ -1,3 +1,3 @@
 # Páginas similares y relacionadas
 
-- https://devhints.io
+- <https://devhints.io>

assets/dotfiles/.bashrc-asrob docs/assets/dotfiles/.bashrc-asrob

@@ -0,0 +1,18 @@
+# Software
+
+* [Control de versiones](version-control/README.md)
+    * [Git](version-control/git.md)
+    * [Subversion (SVN)](version-control/subversion.md)
+* [Docker](docker.md)
+* [Linux](linux/README.md)
+    * [Introducción](linux/introduction.md)
+    * [Bash (consola/terminal)](linux/bash.md)
+    * [Estructura de carpetas en Debian y derivados](linux/folder-structure-debian.md)
+    * [Ficheros de configuración](linux/configuration-files.md)
+* [Programación](programming/README.md)
+    * [CMake](programming/cmake.md)
+    * [Librerías estáticas y dinámicas](programming/libs.md)
+    * [YARP](programming/yarp.md)
+* [Comunicaciones](comunications/README.md)
+* [Codificación de caracteres](character-encoding.md)
+* [Variables de entorno](environment-variables.md)