try manubot
1.0.0
Dieses Repository enthält ein Demo -Manuskript, das als Spielplatz für alle mit Manubot üben kann.
Um das Manuskript zu bearbeiten, ändern Sie Änderungen an den Dateien im content . Sie können Dateien mit der GitHub -Weboberfläche mithilfe des Bleistiftsymbols bearbeiten, wie im Erste -Start -Video gezeigt. Wenn Sie Erfahrung mit Git und GitHub haben, können Sie dieses Repository aufnehmen und eine herkömmliche Pull -Anfrage stellen.
Manubot ist ein System zum Schreiben von wissenschaftlichen Manuskripten über GitHub. Manubot automatisiert Zitate und Referenzen, Versionsmanuskripte mit Git und ermöglicht das gemeinsame Schreiben über GitHub. Ein Überblick -Manuskript bietet die Vorteile des kollaborativen Schreibens mit Manubot und seinen einzigartigen Funktionen. Das RootStock -Repository ist eine Vorlage für allgemeine Zwecke zum Erstellen neuer Manubot -Instanzen, wie in SETUP.md beschrieben. Unter Verwendung USAGE.md finden Sie Unterlagen zum Schreiben eines Manuskripts.
Bitte eröffnen Sie ein Problem für Fragen zu Manubot -Nutzung, Fehlerberichten oder allgemeinen Anfragen.
Die Verzeichnisse sind wie folgt:
content enthält die Manuskriptquelle, die Markdown -Dateien sowie Eingaben für Zitate und Referenzen enthält. Weitere Informationen finden Sie unter USAGE.md .output enthält die Ausgänge (generierte Dateien) aus Manubot einschließlich der resultierenden Manuskripte. Sie sollten diese Dateien nicht manuell bearbeiten, da sie überschrieben werden.webpage ist ein Verzeichnis, das als statische Webseite für das Anzeigen des HTML -Manuskripts ermittelt werden soll.build enthält Befehle und Werkzeuge zum Erstellen des Manuskripts.ci enthält Dateien, die für die Bereitstellung über kontinuierliche Integration erforderlich sind. Der einfachste Weg, Manubot auszuführen, besteht darin, die kontinuierliche Integration zu verwenden, um das Manuskript wieder aufzubauen, wenn sich der Inhalt ändert. Wenn Sie ein Manubot -Manuskript lokal erstellen möchten, installieren Sie die in build beschriebene Conda -Umgebung. Anschließend können Sie das Manuskript auf POSIX -Systemen erstellen, indem Sie die folgenden Befehle aus diesem Root -Verzeichnis ausführen.
# 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 Manchmal ist es hilfreich, das Inhaltsverzeichnis zu überwachen und das Manuskript automatisch wieder aufzubauen, wenn eine Änderung erkannt wird. Der folgende Befehl löst beim Ausführen sowohl den Befehl build.sh -Skript als auch manubot webpage bei Inhaltsänderungen aus:
bash build/autobuild.shImmer wenn eine Pull -Anfrage geöffnet wird, wird CI (kontinuierliche Integration) getestet, ob die Änderungen den Build -Prozess brechen, um ein formatiertes Manuskript zu generieren. Der Build -Prozess zielt darauf ab, gemeinsame Fehler wie ungültige Zitate zu erkennen. Wenn Ihre Pull -Anfrage fehlschlägt, finden Sie in den CI -Protokollen die Ursache des Fehlers und überarbeiten Sie Ihre Pull -Anfrage entsprechend.
Wenn ein Verpflichtung zum main auftritt (z. B. wenn eine Pull-Anfrage zusammengeführt wird), erstellt CI das Manuskript und schreibt die Ergebnisse auf die gh-pages und output . Der gh-pages Zweig verwendet Github-Seiten, um die folgenden URLs zu hosten:
Für kontinuierliche Integrationskonfigurationsdetails finden Sie. .github/workflows/manubot.yaml .
Sofern nicht anders angegeben, ist die Gesamtheit dieses Repositorys unter einer CC durch 4.0 Lizenz ( LICENSE.md ) lizenziert, die die Wiederverwendung mit Zuschreibung ermöglicht. Bitte geben Sie mit https://github.com/Manubot/try-manubot zurück.
Da CC BY für Code und Daten nicht ideal ist, werden bestimmte Repository-Komponenten auch im Rahmen der CC0 1.0 Public Domain Widdication ( LICENSE-CC0.md ) veröffentlicht. Alle Dateien, die mit den folgenden Glob -Mustern übereinstimmen, werden unter CC mit 4.0 und CC0 1.0 doppelt lizenziert:
*.sh*.py*.yml / *.yaml*.json*.bib*.tsv.gitignoreAlle anderen Dateien sind nur unter CC um 4.0 verfügbar, darunter:
*.md*.html*.pdf*.docxBitte eröffnen Sie ein Problem für jede Frage im Zusammenhang mit Lizenzierung.
