Features
Community
❤️ Support this open-source software
To help us develop this converter tool and the associated Wowchemy software sustainably under the MIT license, we ask all individuals and businesses that use it to help support its ongoing maintenance and development via sponsorship and contributing.
Support development of the Academic CLI:
Open your Terminal or Command Prompt app and install the Academic CLI tool:
pip3 install -U academic
Or, help test the latest development version:
pip3 install -U git+https://github.com/wowchemy/hugo-academic-cli.git
Download references from your reference manager, such as Zotero, in the Bibtex format.
Use the cd
command to navigate to the folder containing your Bibtex file:
cd <MY_BIBTEX_FOLDER>
Import publications:
Say we downloaded our publications from our reference manager, such as Zotero, to a file named my_publications.bib
within the website folder. We can import them into the default content/publication/
folder with:
academic import --bibtex my_publications.bib
Import publications to a specific folder (e.g. content/zh/publication
):
Say our site has multiple languages, we may want to output the publications to a specific folder with:
academic import --bibtex my_publications.bib --publication-dir content/zh/publication/
Optional arguments:
--publication-dir PUBLICATION_DIR
Folder to import publications to (defaults to content/publication
)--overwrite
Overwrite any existing publications in the output folder--normalize
Normalize tags by converting them to lowercase and capitalizing the first letter (e.g. "sciEnCE" -> "Science")--featured
Flag these publications as featured (to appear in Featured Publications widget)--verbose
or -v
Show verbose messages--help
HelpAfter importing publications, a full text PDF and image can be associated with each item and further details added via extra parameters.
Interested in contributing to open source and open science?
Learn how to contribute code on Github.
Check out the open issues and contribute a Pull Request.
For local development, clone this repository and use Poetry to install and run the converter using the following commands:
git clone https://github.com/wowchemy/bibtex-to-markdown.git
cd bibtex-to-markdown
poetry install
poetry run academic import --bibtex=tests/data/article.bib --publication-dir=debug --overwrite
Preparing a contribution:
make lint
make format
make test
Copyright 2018-present George Cushen.
Licensed under the MIT License.