try manubot
1.0.0
Ce référentiel contient un manuscrit de démonstration, destiné à un terrain de jeu pour que tout le monde s'entraîne à l'aide de Manubot.
Pour modifier le manuscrit, apportez des modifications aux fichiers dans le répertoire content . Vous pouvez modifier des fichiers avec l'interface Web GitHub en utilisant l'icône du crayon, comme indiqué dans la vidéo de démarrage. Alternativement, si vous avez de l'expérience avec Git et Github, vous pouvez débarquer ce référentiel et faire une demande de traction traditionnelle.
Manubot est un système pour écrire des manuscrits savants via Github. Manubot automatise les citations et les références, les versions manuscrits utilisant GIT et permet une écriture collaborative via GitHub. Un manuscrit d'aperçu présente les avantages de l'écriture collaborative avec Manubot et ses fonctionnalités uniques. Le référentiel de porte-greffe est un modèle à usage général pour créer de nouvelles instances de manubot, comme détaillé dans SETUP.md . Voir USAGE.md pour la documentation Comment rédiger un manuscrit.
Veuillez ouvrir un problème pour les questions liées à l'utilisation de Manubot, aux rapports de bogues ou aux demandes générales.
Les répertoires sont les suivants:
content contient la source du manuscrit, qui comprend des fichiers de démarque ainsi que des entrées pour les citations et les références. Voir USAGE.md pour plus d'informations.output contient les sorties (fichiers générés) à partir de manubot, y compris les manuscrits résultants. Vous ne devez pas modifier ces fichiers manuellement, car ils seront écrasés.webpage est un répertoire destiné à être rendu comme une page Web statique pour consulter le manuscrit HTML.build contient des commandes et des outils pour construire le manuscrit.ci contient des fichiers nécessaires au déploiement via une intégration continue. La façon la plus simple d'exécuter Manubot est d'utiliser l'intégration continue pour reconstruire le manuscrit lorsque le contenu change. Si vous souhaitez créer un manuscrit Manubot localement, installez l'environnement Conda comme décrit dans build . Ensuite, vous pouvez créer le manuscrit sur les systèmes POSIX en exécutant les commandes suivantes à partir de ce répertoire racine.
# 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 Parfois, il est utile de surveiller le répertoire de contenu et de reconstruire automatiquement le manuscrit lorsqu'une modification est détectée. La commande suivante, lors de l'exécution, déclenchera à la fois la commande build.sh Script et la commande manubot webpage lors des modifications de contenu:
bash build/autobuild.shChaque fois qu'une demande de traction est ouverte, CI (intégration continue) testera si les modifications cassent le processus de construction pour générer un manuscrit formaté. Le processus de construction vise à détecter les erreurs courantes, telles que des citations non valides. Si votre version de demande de traction échoue, consultez les journaux CI pour la cause de l'échec et révisez votre demande de traction en conséquence.
Lorsqu'un engagement dans la branche main se produit (par exemple, lorsqu'une demande de traction est fusionnée), CI construit le manuscrit et écrit les résultats des branches gh-pages et output . La branche gh-pages utilise des pages GitHub pour héberger les URL suivantes:
Pour les détails de configuration d'intégration continue, voir .github/workflows/manubot.yaml .
Sauf indication contraire, l'intégralité de ce référentiel est concédé sous licence CC par 4.0 ( LICENSE.md ), qui permet une réutilisation avec l'attribution. Veuillez attribuer en liant à https://github.com/manubot/try-manubot.
Étant donné que CC BY n'est pas idéal pour le code et les données, certains composants du référentiel sont également publiés dans le cadre de la dédicace du domaine public CC0 1.0 ( LICENSE-CC0.md ). Tous les fichiers correspondants par les modèles GLOB suivants sont en double licence sous CC par 4.0 et CC0 1.0:
*.sh*.py*.yml / *.yaml*.json*.bib*.tsv.gitignoreTous les autres fichiers ne sont disponibles que sous CC par 4.0, notamment:
*.md*.html*.pdf*.docxVeuillez ouvrir un problème à toute question liée à la licence.
