Do you want to create a website from a single source or do you want to create your own theme and build up a publication series?
xCode command line tools
# Check if exist: $ xcode-select --version # Otherwise install: $ xcode-select --install
# Check if exist: $ brew --version # Otherwise install: $ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"
# Check for installed version: $ brew info python # Otherwise install: $ brew install email@example.com
# Check if exists: $ pipenv --version # If none installed, check which pip is installed: $ pip --version $ pip3 --version # Install pipenv, use pip or pip3 depending on which routes to python 3.x: $ sudo pip3 install pipenv
Install from official websites:
Python (Make sure to check the box for PATH variables to be set)
Git (includes Git-Bash)
Open Git-Bash to install Pipenv
# Check if exists: $ pipenv --version # Install pipenv: $ pip install pipenv
You might run into errors regarding your installed/default version of python in the further installation steps.
# Install pyenv-win by running the following installation command in a PowerShell terminal: $ Invoke-WebRequest -UseBasicParsing -Uri "https://raw.githubusercontent.com/pyenv-win/pyenv-win/master/pyenv-win/install-pyenv-win.ps1" -OutFile "./install-pyenv-win.ps1"; &"./install-pyenv-win.ps1" # If you are getting any UnauthorizedAccess error, start Windows PowerShell with the "Run as administrator" option and run Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope LocalMachine # now re-run the above installation command
Here you can find detailed installation instructions (via the PowerShell):
You can a) work on an existing graphite publication repository, or b) start from scratch with our graphite starter.
Clone existing repository
# Move to folder, where the article files shall be located (use tab key to autocomplete) $ cd ~/PATH_TO_FOLDER_FROM_HOME_DIRECTORY # Copy repository url from github and clone $ git clone REPOSITORY_URL # If you're using git for the first time, proceed with promted sign-in procedures
Use graphite starter
Our starter is provided by cookiecutter.
# Check for installed version: $ cookiecutter --version # Otherwise install (OSX/Linux): $ brew install cookiecutter
Install the starter.
# Download and init graphite starter: $ cookiecutter gh:impactdistillery/graphite-starter
Cookiecutter will prompt you to enter a title, authors etc. for your publication. Your
journal_slug will be the name of the directory created by cookiecutter.
# Change to your repository $ cd JOURNAL_SLUG
Start development environment
Change into repository folder.
If you're there for the first time, do an install
$ pipenv install
You might run into errors regarding your installed/default version of python. Use Pyenv to administer Phython versions in Pipenv.
Then start environment
$ pipenv shell
$ python PAPER_FOLDER/manage.py runserver
The default port is 8000. If you want to run more than one paper at once, you can specify different ports with a blank after
runserver such as
$ python OTHER_PAPER_FOLDER/manage.py runserver 8001
Install a text editor to edit your graphite publication
You can use the text or source code editor of your choice to create a graphite paper. If you're not too familiar with the command line, we suggest the use of one of the following editors:
Publish graphite paper
Change into repository folder.
$ python PAPER_FOLDER/manage.py build
The paper and all assets will be rendered into the folder
_build. The contents of this folder can be copied to the desired location or server in order to publish the website.
Currently the static folder needs to be located in the root folder. It needs to be copied manually into the root folder of the server in order for the paper to work within a subdirectory.