The website designer for Hugo
Project description
Admin Tool for Academic
An admin tool for Academic.
Features
- Import publications from BibTeX
- Hugo command pass-through
Community
- 💬 Chat with the Academic community or Hugo community
- 🐦 Twitter: @source_themes @GeorgeCushen #MadeWithAcademic
Support
Support development of Academic:
- ❤️ Become a backer and unlock rewards
- ☕️ Donate a coffee
- 🖼️ Decorate your laptop or journal with an Academic sticker
- :woman_technologist: Contribute
Prerequisites
- Install the Academic website framework
- Install Python 3.6+ if it’s not already installed
- Version control your website with Git so that you can review the proposed changes and accept or reject them without risking breaking your site. Otherwise, if not using Git, backup your site prior to running this tool.
Installation
Open your Terminal or Command Prompt app and install Academic’s admin tool:
pip3 install -U academic
Usage
Use the cd
command to navigate to your website folder in the terminal:
cd <MY_WEBSITE_FOLDER>
Help:
academic
Import publications:
academic import --bibtex my_publications.bib
Optional arguments:
--help
Help--featured
Flag publications as featured (to appear in Featured Publications widget)--overwrite
Overwrite existing publications--publication-dir PUBLICATION_DIR
Path to your publications directory (defaults topublication
)--normalize
Normalize tags by converting them to lowercase and capitalizing the first letter--verbose
or-v
Show 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
Contribute
For local development, clone this repository and use Pipenv to install the tool using the following commands:
pip3 install pipenv
pipenv install -e .
Preparing a contribution:
- Lint:
make lint
- Format:
make format
- Test:
make test
License
Copyright 2018-present George Cushen.
Licensed under the MIT License.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.