academic file converter

中文

學術文件轉換器

輕鬆地將出版物和jupyter筆記本註冊到您的Markdown-Formatted網站或書籍

特徵

• 導入Jupyter筆記本作為博客文章或書籍章節
• 從您的參考經理到您的Markdown-Formatted網站或書籍的導入出版物（例如書籍，會議程序和期刊）
  • 只需從您的參考管理器（例如Zotero）導出Bibtex文件，然後將其作為轉換器工具的輸入
• 與所有靜態網站發電機兼容，例如Next，Astro，Gatsby，Hugo等。
• 易於使用- 100％Python，不依賴複雜軟件，例如Pandoc
• 使用github操作自動化文件轉換

社區

• 查看以下文檔
• 與不和諧與社區現場聊天
• ？ Twitter：@getResearchDev @georgecushen #madewithacademic

❤️支持開放研究和開源

我們的使命是通過開發這樣的開源工具來促進開放研究。

為了幫助我們在MIT許可下可持續地開發此開源軟件，我們要求所有使用它來幫助其持續維護和開發的個人和企業通過贊助和貢獻。

支持開放研究運動：

• 配進Github上的這個項目明星
• ❤️成為GitHub贊助商並解鎖特權
• ☕️捐贈咖啡
• ？貢獻

安裝

打開您的終端或命令提示應用程序，然後輸入以下安裝命令之一。

使用pipx

對於最簡單的安裝，請使用PIPX安裝：

 pipx install academic

PIPX將在專用環境中自動為您安裝所需的Python版本。

與pip

要使用Python的PIP工具安裝，請確保已安裝Python 3.11+，然後運行：

 pip3 install -U academic

用法

打開您的命令行或終端應用程序，然後使用cd命令導航到包含您要轉換的文件的文件夾，例如：

 cd ~/Documents/my_website

進口出版物

以Bibtex格式從您的參考管理器（例如Zotero）下載引用。

假設我們將列為列表下載到網站文件夾中名為my_publications.bib的文件中，讓我們將其導入到content/publication/文件夾中：

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

可選參數：

• --compact在沒有評論或空鍵的情況下生成最小的降價
• --overwrite撰寫輸出文件夾中的任何現有出版物
• --normalize通過將標籤轉換為小寫並大寫的第一個字母（例如“科學” - >“ science”）來歸一化標籤。
• --featured旗幟的標誌這些出版物的特色（將出現在您網站的特色出版物部分中）
• --verbose或-v顯示詳細消息
• --help幫助幫助

導入全文和封面圖像

進口出版物後，我們建議您：

• 編輯每個出版物的降價主體，以將全文直接添加到頁面上（如果出版物是打開訪問），或其他方式為每個出版物添加補充說明
• 在每個出版物的文件夾中添加一個featured的圖像，以視覺上表示您在頁面上的出版物並在社交媒體上共享
• 將出版物PDF添加到每個出版物文件夾（用於開放訪問出版物）中，以使您的網站訪問者下載您的出版物

在Hugo Blox文檔中了解更多信息。

導入Jupyter筆記本的博客文章

假設我們在網站文件夾中的notebooks文件夾中有筆記本，讓我們將其導入到content/post/ folder中：

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

可選參數：

• --overwrite撰寫輸出文件夾中的任何現有博客文章
• --verbose或-v顯示詳細消息
• --help幫助幫助

貢獻

有興趣為開源和開放研究做出貢獻嗎？

了解如何在GitHub上撰寫代碼。

查看空曠的問題並貢獻提取請求。

對於本地開發，請克隆此存儲庫，並使用詩歌使用以下命令安裝和運行轉換器：

 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

準備貢獻時，請運行以下檢查並確保它們都通過：

• 皮棉： make lint
• 格式： make format
• 測試： make test
• 類型檢查： make type

幫助beta測試開發版本

您可以通過安裝GitHub的最新main分支來幫助測試最新的開發版本：

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

執照

版權所有2018年至今的喬治·庫森（George Cushen）。

根據MIT許可獲得許可。