Si tenemos un proyecto albergado en Github que necesita de una amplia documentación en el repositorio para todo aquel que quiera saber qué hace y decidir si descargarlo o cómo usarlo, nos será útil estructurar el Readme con una tabla de contenidos. Esto es más sencillo de lo que parece usando markdown. La estructura sería la siguiente:
# Tabla de contenidos
1. [Programacion](#programacion)
1. [General](#general)
2. [Python](#python)
3. [Exoresiones regulares](#expresiones-regulares)
4. [Java](#java)
5. [Scratch](#scratch)
3. [Desarrollo Web](#desarrollo-web)
4. [Desarrollo de apps](#apps-moviles)
5. [Bases de datos](#bases-de-datos)
6. [Redes](#redes)
7. [Control de versiones](#control-de-versiones)
8. [Ofimatica](#ofimatica)
9. [Informatica general](#informatica-general)
10. [Sistemas Operativos](#sistemas-operativos)
11. [Otros](#otros)
## Programacion
### General
### Python
### Expresiones regulares
### Java
### Scratch
## Desarrollo web
## Apps moviles
## Bases de datos
## Redes
## Control de versiones
## Ofimatica
## Informatica general
## Sistemas Operativos
## Otros
Entre corchetes escribiremos el texto que queremos que aparezca y entre
paréntesis el enlace hacia el que nos llevará, en este caso a otras
secciones dentro del documento. Las secciones deben ir en el mismo orden en el que aparecen los enlaces.
No hay comentarios:
Publicar un comentario
Comenta lo que quieras