christianbrodbeck / academic-admin

Admin tool for Academic

Admin Tool for Academic

An admin tool for Academic.

Features

• Import publications from BibTeX
• Import third-party assets to generate an entirely offline site

Prerequisites

1. Install the Academic website framework
2. Install Python 3 if it’s not already installed
3. 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 Selected Publications widget)
• --overwrite Overwrite existing publications
• --publication-dir PUBLICATION_DIR Your publications directory (defaults to publication)

After importing publications, a full text PDF and image can be associated with each item and further details added via extra parameters.

Import third-party JS and CSS assets for building an offline website:

academic import --assets

Importing assets requires Academic v3+.

Run a Hugo command (pass-through):

academic server

Contribute

For local development, clone this repository and install the tool using the following command:

pip3 install -e .

License

Copyright 2018-present George Cushen.

Licensed under the MIT License.