try manubot
1.0.0
Este repositorio contiene un manuscrito de demostración, destinado como un patio de recreo para que todos practiquen el uso de Manubot.
Para editar el manuscrito, realice cambios en los archivos en el directorio content . Puede editar archivos con la interfaz web GitHub utilizando el icono de lápiz, como se muestra en el video de Getting Start. Alternativamente, si tiene experiencia con Git y GitHub, puede desembolsar este repositorio y hacer una solicitud de extracción tradicional.
Manubot es un sistema para escribir manuscritos académicos a través de Github. Manubot automatiza citas y referencias, manuscritos de versiones que usan GIT, y habilita la escritura colaborativa a través de GitHub. Un manuscrito general presenta los beneficios de la escritura colaborativa con Manubot y sus características únicas. El repositorio de portainjertos es una plantilla de propósito general para crear nuevas instancias de Manubot, como se detalla en SETUP.md . Consulte USAGE.md para la documentación sobre cómo escribir un manuscrito.
Abra un problema para las preguntas relacionadas con el uso de Manubot, los informes de errores o las consultas generales.
Los directorios son los siguientes:
content contiene la fuente del manuscrito, que incluye archivos de Markdown, así como entradas para citas y referencias. Consulte USAGE.md para obtener más información.output contiene las salidas (archivos generados) de Manubot, incluidos los manuscritos resultantes. No debe editar estos archivos manualmente, porque se sobrescribirán.webpage es un directorio destinado a ser representada como una página web estática para ver el manuscrito HTML.build contiene comandos y herramientas para construir el manuscrito.ci contiene archivos necesarios para la implementación a través de la integración continua. La forma más fácil de ejecutar Manubot es usar la integración continua para reconstruir el manuscrito cuando cambia el contenido. Si desea construir un manuscrito de Manubot localmente, instale el entorno de conda como se describe en build . Luego, puede construir el manuscrito en los sistemas POSIX ejecutando los siguientes comandos desde este directorio raíz.
# Activate the manubot conda environment (assumes conda version >= 4.4)
conda activate manubot
# Build the manuscript, saving outputs to the output directory
bash build/build.sh
# At this point, the HTML & PDF outputs will have been created. The remaining
# commands are for serving the webpage to view the HTML manuscript locally.
# This is required to view local images in the HTML output.
# Configure the webpage directory
manubot webpage
# You can now open the manuscript webpage/index.html in a web browser.
# Alternatively, open a local webserver at http://localhost:8000/ with the
# following commands.
cd webpage
python -m http.server A veces es útil monitorear el directorio de contenido y reconstruir automáticamente el manuscrito cuando se detecta un cambio. El siguiente comando, mientras se ejecuta, activará tanto el comando build.sh script como el comando manubot webpage en cambios de contenido:
bash build/autobuild.shCada vez que se abre una solicitud de extracción, CI (integración continua) probará si los cambios rompen el proceso de compilación para generar un manuscrito formateado. El proceso de compilación tiene como objetivo detectar errores comunes, como citas no válidas. Si la compilación de su solicitud de extracción falla, consulte los registros de CI para la causa de la falla y revise su solicitud de extracción en consecuencia.
Cuando se produce un compromiso con la rama main (por ejemplo, cuando se fusiona una solicitud de extracción), CI construye el manuscrito y escribe los resultados en las ramas gh-pages y output GH. La sucursal de gh-pages utiliza páginas GitHub para alojar las siguientes URL:
Para obtener detalles de configuración de integración continua, consulte .github/workflows/manubot.yaml .
Excepto cuando se indica lo contrario, la totalidad de este repositorio tiene licencia bajo una licencia CC por 4.0 ( LICENSE.md ), que permite la reutilización con atribución. Atribuya al vincular a https://github.com/manubot/try-manubot.
Dado que CC por no es ideal para código y datos, ciertos componentes del repositorio también se lanzan bajo la dedicación del dominio público CC0 1.0 ( LICENSE-CC0.md ). Todos los archivos coincidentes con los siguientes patrones de globos tienen licencia dual bajo CC por 4.0 y CC0 1.0:
*.sh*.py*.yml / *.yaml*.json*.bib*.tsv.gitignoreTodos los demás archivos solo están disponibles en CC por 4.0, incluyendo:
*.md*.html*.pdf*.docxAbra un problema para cualquier pregunta relacionada con la licencia.
