Este script permite dividir el archivo README.md principal en archivos individuales, uno por cada sección marcada con ###, y genera una tabla de contenidos con enlaces a cada archivo generado.
-
Ubicación del script:
- El script
split_readme_sections.pydebe estar en el directorio raíz del proyecto. - El archivo
README.mddebe estar también en el directorio raíz.
- El script
-
Ejecución:
- Abre una terminal en la raíz del proyecto.
- Ejecuta el siguiente comando:
python3 split_readme_sections.py
-
Resultado:
- Se creará (o actualizará) la carpeta
docs/en la raíz del proyecto. - Dentro de
docs/se generarán archivos.mdnumerados, uno por cada sección del README. - Se generará un archivo
00_TableofContents.mdcon enlaces a cada sección.
- Se creará (o actualizará) la carpeta
-
Notas:
- No se genera archivo de sección para la tabla de contenidos.
- Si editas el README.md, puedes volver a ejecutar el script para actualizar los archivos.
python3 split_readme_sections.pyLuego revisa la carpeta docs/ para ver los archivos generados.