📚 Import academic publications from Bibtex to Hugo
Features
Community
❤️ Support this open-source software
To help us develop this Academic CLI 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
Alternatively, install Academic CLI v0.5.1 if you do not wish to install Hugo on your computer:
pip3 install academic==0.5.1
Or, help test the lastest development version:
pip3 install -U git+https://github.com/wowchemy/hugo-academic-cli.git
Use the
cdcommand to navigate to your website folder in the terminal:
cd
Help:
academic
Import publications:
academic import --bibtex my_publications.bib
Optional arguments:
--helpHelp
--featuredFlag publications as featured (to appear in Featured Publications widget)
--overwriteOverwrite existing publications
--publication-dir PUBLICATION_DIRPath to your publications directory (defaults to
publication)
--normalizeNormalize tags by converting them to lowercase and capitalizing the first letter
--verboseor
-vShow verbose messages
After importing publications, a full text PDF and image can be associated with each item and further details added via extra parameters.
Run a Hugo command (pass-through):
academic server
For local development, clone this repository and use Pipenv to install the tool using the following commands:
git clone https://github.com/wowchemy/hugo-academic-cli.git cd hugo-academic-cli pip3 install pipenv pipenv install -e .
Preparing a contribution:
make lint
make format
make test
Copyright 2018-present George Cushen.
Licensed under the MIT License.