academic file converter

中文

Akademischer Dateikonverter

Importieren Sie einfach Publikationen und Jupyter-Notizbücher in Ihre Markdown-formatierte Website oder Ihr Buch

Merkmale

• Importieren Sie Jupyter -Notizbücher als Blog -Beiträge oder Buchkapitel
• Importieren Sie Publikationen (wie Bücher, Konferenzverfahren und Zeitschriften ) von Ihrem Referenzmanager in Ihre von Markdown-formatierte Website oder Buch
  • Exportieren Sie einfach eine Bibtex -Datei aus Ihrem Referenzmanager wie Zotero und geben Sie diese als Eingabe für das Konverter -Tool an
• Kompatibel mit allen statischen Website -Generatoren wie Next, Astro, Gatsby, Hugo usw.
• Einfach zu verwenden - 100% Python, keine Abhängigkeit von komplexen Software wie Pandoc
• Automatisieren Sie Dateikonvertierungen mithilfe einer GitHub -Aktion

Gemeinschaft

• Sehen Sie sich die folgende Dokumentation an
• Chatten Sie live mit der Community über Zwietracht
• ? Twitter: @getResearchDev @GeOrgeCushen #MadeWithacademic

❤️ Unterstützung Open Research & Open Source unterstützen

Wir sind auf der Mission, offene Forschung zu fördern, indem wir Open Source -Tools wie diesen entwickeln.

Um uns bei der Entwicklung dieser Open -Source -Software nachhaltig unter der MIT -Lizenz zu entwickeln, bitten wir alle Einzelpersonen und Unternehmen, die sie verwenden, um ihre laufende Wartung und Entwicklung durch Sponsoring und Beitrag zu unterstützen.

Unterstützen Sie die offene Forschungsbewegung:

• ️ spar dieses Projekt auf Github
• ❤️ Github Sponsor werden und Vorteile freischalten
• ☕️ Spenden Sie einen Kaffee
• ? beitragen

Installation

Öffnen Sie Ihre Terminal- oder Eingabeaufforderung -App und geben Sie einen der folgenden Installationsbefehle ein.

Mit PIPX

Für die einfachste Installation installieren Sie mit PIPX:

 pipx install academic

PIPX installiert automatisch die erforderliche Python -Version für Sie in einer speziellen Umgebung.

Mit Pip

Um mithilfe des PIP -Tools des Python zu installieren, stellen Sie sicher, dass Sie Python 3.11+ installieren und dann ausführen:

 pip3 install -U academic

Verwendung

Öffnen Sie Ihre Befehlszeile oder Terminal -App und verwenden Sie den Befehl cd , um zu dem Ordner zu navigieren, der die Dateien enthält, die Sie konvertieren möchten, zum Beispiel:

 cd ~/Documents/my_website

Veröffentlichungen importieren

Laden Sie Referenzen von Ihrem Referenzmanager wie Zotero im Bibtex -Format herunter.

Sagen Sie, wir haben unsere Veröffentlichungen in eine Datei namens my_publications.bib im Website -Ordner heruntergeladen. Importieren wir sie in den content/publication/ den Ordner:

 academic import my_publications.bib content/publication/ --compact

Optionale Argumente:

• --compact erzeugen minimalen Markdowns ohne Kommentare oder leere Schlüssel
• --overwrite überschreiben vorhandenen Veröffentlichungen im Ausgangsordner
• --normalize Normalisieren Sie Tags, indem Sie sie in Kleinbuchstaben umwandeln und den ersten Buchstaben aktivieren (zB "Wissenschaft" -> "Wissenschaft")
• --featured Sie diese Veröffentlichungen wie vorgestellt (um im Abschnitt "Publications" Ihrer Website zu sehen)
• --verbose oder -v ausführliche Nachrichten anzeigen
• --help Hilfe

Volltext und Titelbild importieren

Nach dem Importieren von Veröffentlichungen empfehlen wir Ihnen:

• Bearbeiten Sie den Markdown -Körper jeder Veröffentlichung, um den Volltext direkt zur Seite hinzuzufügen (falls die Veröffentlichung offener Zugriff ist), oder auf andere Weise, um zusätzliche Notizen für jede Veröffentlichung hinzuzufügen
• Fügen Sie ein Bild hinzu, das dem Ordner jeder Veröffentlichung featured , um Ihre Veröffentlichung auf der Seite visuell zu vertreten und in den sozialen Medien zu teilen
• Fügen Sie die Veröffentlichung PDF zu jedem Publikationsordner (für Open Access Publications) hinzu, damit Ihre Website -Besucher Ihre Veröffentlichung herunterladen können

Erfahren Sie mehr in den Hugo Blox -Dokumenten.

Blog -Beiträge von Jupyter -Notizbüchern importieren

Angenommen, wir haben unsere Notizbücher in einem notebooks -Ordner im Website -Ordner. Importieren wir sie in den content/post/ Ordner:

 academic import 'notebooks/*.ipynb' content/post/ --verbose

Optionale Argumente:

• --overwrite überschreiben vorhandenen Blog-Posts im Ausgabeordner
• --verbose oder -v ausführliche Nachrichten anzeigen
• --help Hilfe

Beitragen

Möchten Sie zu Open Source und Open Research beitragen?

Erfahren Sie, wie Sie Code auf GitHub beisteuern.

Schauen Sie sich die offenen Probleme an und tragen Sie eine Pull -Anfrage bei.

Klonen Sie für die lokale Entwicklung dieses Repository und verwenden Sie die Poesie, um den Konverter mit den folgenden Befehlen zu installieren und auszuführen:

 git clone https://github.com/GetRD/academic-file-converter.git
cd academic-file-converter
poetry install
poetry run academic import tests/data/article.bib output/publication/ --overwrite --compact
poetry run academic import 'tests/data/**/*.ipynb' output/post/ --overwrite --verbose

Führen Sie bei der Erstellung eines Beitrags die folgenden Schecks durch und stellen Sie sicher, dass sie alle bestehen:

• Lint: make lint
• Format: make format
• Test: make test
• Geben Sie Check ein: make type

Helfen Sie Beta, die Entwicklerversion zu testen

Sie können helfen, die neueste Entwicklungsversion zu testen, indem Sie die neueste main von GitHub installieren:

 pip3 install -U git+https://github.com/GetRD/academic-file-converter.git

Lizenz

Copyright 2018-Present George Cushen.

Lizenziert unter der MIT -Lizenz.