academic-file-converter

(★ 418)

📚 Import Bibtex publications and Jupyter Notebook blog posts into your Markdown website or book. 将Bibtex转换为Markdown网站

File Explorer

Download Latest Version (.zip)

- - demo.gif
- - codeql-analysis.yml
  - stale.yml
  - test.yml
- FUNDING.yml
- - publication.md
- cli.py
- generate_markdown.py
- import_bibtex.py
- import_notebook.py
- jupyter_whitespace_remover.py
- publication_type.py
- utils.py
- - article.bib
  - book.bib
  - report.bib
  - thesis.bib
- test_bibtex_import.py
- test_notebook_import.py
.flake8
.gitignore
LICENSE.md
Makefile
poetry.lock
pyproject.toml
README.md
README.zh.md

# Installation Guide

1. Get the code

git clone https://github.com/HugoBlox/academic-file-converter

Downloads the entire project code from GitHub to your computer.

cd academic-file-converter

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended

Prerequisites

pipx Installs Python-based CLI tools into isolated environments.
Python 3 Python is required to use pip.

pipx install academic

Installs the CLI tool into an isolated environment via pipx.

pip3 install -U academic

Installs the package published on PyPI directly — no need to clone the source.

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

Installs the package published on PyPI directly — no need to clone the source.

✅ After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Python

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.

pip3 install -U academic

Installs the package published on PyPI directly — no need to clone the source.

poetry install

Installs the libraries listed in pyproject.toml.

poetry run academic import tests/data/article.bib output/publication/ --overwrite --compact

Type this command into your terminal and run it.

poetry run academic import 'tests/data/**/*.ipynb' output/post/ --overwrite --verbose

Type this command into your terminal and run it.

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

Installs the package published on PyPI directly — no need to clone the source.

✅ If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

4. Make

Medium

Prerequisites

Git Needed to download the project code from GitHub.
Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).

make

Compiles the code based on the generated build configuration to produce an executable.

✅ If it finishes without errors, it worked. Try running the generated executable directly.