Create a Graphite paper

Create a publication repository

The easiest way to start your first graphite paper is to use our cookiecutter starter. If you prefer to start with a full, prefilled sample publication, you can clone our sample journal repository instead.

Create publication with starter

A documentation of how to install our starter can be found here:

Use graphite starter

This will give you a publication repository with the following page structure:

YOUR_JOURNAL_SLUG/

YOUR_JOURNAL_SLUG
│
├── YOUR_PAPER_SLUG
│   ├── assets
│   │   └── images
│   │   │   └── header.jpg
│   │
│   ├── config
│   │   ├── development.py
│   │   ├── lang.yaml
│   │   └── meta.yaml
│   │
│   ├── pages
│   │   ├── index.md
│   │   ├── imprint.md
│   │
│   ├── theme
│   │   ├── fonts
|   │   │   └── ...
│   │   ├── images
|   │   │   └── graphite.svg
│   │   └── styles
|   │       └── sample-journal.css
│   │
│   └── manage.py
│
├── Pipfile
│
└── README.md

Download sample journal

A preview of the sample publication can be seen here: graphite-paper.netlify.app

To copy this sample, clone the following repository.

$ git clone github.com/crosssenses/sample-journal

This will give you a publication repository with the following page structure:

sample-journal/

sample-journal
│
├── sample-paper
│   ├── assets
│   │   ├── figures
|   │   │   └── ...
│   │   ├── images
│   │   └── csv
│   │
│   ├── config
│   │   ├── development.py
│   │   ├── lang.yaml
│   │   └── meta.yaml
│   │
│   ├── pages
│   │   ├── about.md
│   │   ├── directories.md
│   │   ├── editors.md
│   │   ├── index.md
│   │   └── references.yaml
│   │
│   ├── theme
│   │   ├── fonts
|   │   │   └── ...
│   │   ├── images
|   │   │   └── graphite.svg
│   │   └── styles
|   │       └── sample-journal.css
│   │
│   └── manage.py
│
├── .gitignore
│
├── Pipfile
│
├── Pipfile.lock
│
└── README.md

Add meta information

All meta information and some settings are added in config/meta.yaml.

Sample meta.yaml:

# PUBLICATION META INFO
# —————————————————————

title:                  "Das Scholar-led.network-Manifest"
subtitle:               "Wissenschaftliche Publikationen im Open Access, von der
wissenschaftlichen Community betrieben, gefördert, geleitet"
authors:                ""
year:                   2021
date_publication:       Mai 2021
# date_submission:
# date_last_updated:

# keywords:
abstract:               "Das Manifest ist das Ergebnis der Diskussionen in der Fokusgruppe Scholar-led.network (als Teil des open-access.networks). Es beschreibt die Zusammensetzung einer Gruppe von Scholar-led Akteur*innen in Deutschland, umreißt deren zentrale Kritik am gegenwärtigen, wissenschaftlichen Publikationssystem und definiert Handlungsfelder für faires, planvolles und vielfältiges Publizieren."

cite_as:               "Fokusgruppe Scholar-led.network. (2021) *Das Scholar-led.network-Manifest*. DOI: XXX"

pdf_url:                https://doi.org/10.5281/zenodo.4291999
doi:                    10.5281/zenodo.4291999
# isbn:                   978-989-746-128-6
contact_email:          marcel.wrzesinski@hiig.de

short_url:              https://graphite.page/hiig-dapla
social_image_url:       https://graphite.page/hiig-dapla/assets/images/social.png
lang:                   de


# PUBLICATION STYLE
# —————————————————————
styles:                 theme/styles/manifesto.css
background_url:         assets/images/amanda-lins-aVKUVLIsl1o-unsplash.jpg



# DISCLAIMER
# —————————————————————
data_usage:
disclaimer:
terms_of_use:
licence:

# Author info is shown in footer bar and on the right, if no logo is provided.
author_info:            Ein Manifest der Fokusgruppe Scholar-led im Rahmen des Projekts open-access.network
logo_url:


# SETTINGS
# —————————————————————

author_info_sticky:     true
no_journal:             true
translation_nav:        false
matomo_tracking:        true
matomo_url:             "https://piwik.wunderjewel.de/"
matomo_siteId:          "4"

# ADDITIONAL LANGUAGES
# Add language navigation in settings and links below
# —————————————————————

# further_languages:
#   - label: DE
#     url: https://graphite.page/scholar-led-manifest/
#   - label:  EN
#     url: https://graphite.page/scholar-led-manifesto-en/
#     current: true


# PUBLISHER INFO
# thanks for mentioning graphite
# —————————————————————

brand:                  graphite – Enhanced publications for a digital environment
brand_url:              https://www.impactdistillery.com/graphite
brand_logo:             theme/images/graphite.svg

# Infos in expandable header
# imprint:                "Dieses Manifest ist als Ergebnis der Diskussionen in der [Fokusgruppe Scholar-led](https://open-access.net/digitale-fokusgruppen/fokusgruppe-scholar-led) im Rahmen des Projekts [open-access.network](https://open-access.net/digitale-fokusgruppen) entstanden.\n\n
# Die Veröffentlichung wurde mit Graphite erstellt, ein Open-Source-Framework für digitales Publizieren."

# further_publications:
#   - label: Kooperationen zwischen Startups und Mittelstand
#     url: https://www.impactdistillery.com/graphite/hiig-sum/
#   - label:  Plattforminnovation im Mittelstand
#     url: https://graphite.page/hiig-dapla/

# further_links:
#   - label: Graphite Projektwebsite
#     url: https://www.impactdistillery.com/graphite
#   - label: graphite-paper auf PyPI
#     url: https://pypi.org/project/graphite-paper


:---------------------------------------------------:
# TABS
# —————————————————————

tabs:
  - title: "Manifest"
    slug: index
    include_abstract: true
    md_container: article
  - title: "Autor*innen"
    slug: editors
    md_container: section
  - title: "Referenzen"
    slug: directories
    md_container: section
  - title: "Zur Fokusgruppe"
    slug: about
    md_container: section

Key	Value	Comment
PUBLICATION META INFO
title	Publication title	mandatory
subtitle	Publication subtitle
authors	Last Name, F. N., Last Name, F. N., & Last Name, F. N.	mandatory (use "" if no authors)
year	Year of publication
date_publication	Date of publication
date_submission	Date of submission
date_last_updated	Date of most recent update
keywords	Keywords (comma separated)
abstract	Abstract	md syntax and inline components supported
cite_as	Citation suggestion	md syntax supported
pdf_url	Url to pdf file
doi	Digital Object Identifier
isbn	ISBN
contact_email	Email address of contact person
short_url	Final publication URL
social_image_url	Absolute path to share pic	Used for sharing
lang	2-digit language code (de/en)
PUBLICATION STYLE
styles	theme/styles/STYLESHEET_NAME.css
background_url	assets/images/HEADER_IMAGE.jpg
DISCLAIMER
data_usage:	How can and shall research data be used?
disclaimer:	Need to add a disclaimer?
terms_of_use:	Add terms of use here
licence:	Add licence here	e.g., CC-BY-4.0
author_info	Shown in footer and instead of logo if none provided
logo_url	Relative path to publisher logo
SETTINGS
author_info_sticky	Make footer bar sticky	true/false
no_journal	Disable expandable top navigation	true/false
translation_nav:	Enable language switch	true/false
matomo_tracking	Enable Matomo statistics	true/false
matomo_url	URL of Mataomo tracking
matomo_siteId	Matomo site ID
ADDITIONAL LANGUAGES
further_languages:	Link list to translations	yaml list syntax
PUBLISHER INFO
brand	graphite or whitelabel brand
brand_url	URL to graphite or whitelabel brand
brand_logo	Relative path to brand logo
imprint	Left column of top navigation	md syntax supported
further_publications	List of further journal publications	yaml list syntax
further_links	Link list with external content	yaml list syntax
Tabs
tabs	List of tabs for publication (see below)	yaml list syntax

Define tabs:

Tabs subkey	Value
title	Tab caption
slug	Tab slug for URL
include_abstract	Include abstract and meta infos on top
md_container	HTML tag wrapping tab content Sample theme provides styles for article and section

Add page content

To add content to your publication, edit or create pages/index.md. Pages are written in Markdown with additional, graphite-specific syntax for components.

Blank lines divide logical blocks (e.g. paragraphs including asides).

Example for markdown:

# Markdown

This an **bold** example with a bullet list:

* one
* two
* three

Further resources on markdown

• https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet

• https://guides.github.com/features/mastering-markdown/

• https://github.github.com/gfm/

The content of your publication can be enhanced by the following type of components:

• Marginal component

• Inline component

• Container component

• Full-width component

To create additional pages, add Marktdown files to pages/SOME_PAGE_SLUG.md and add tab title and page slug in config/meta.yaml.

To add inline literature refences, create a reference list pages/references.yaml and use the inline component Reference.

In order to print the full list of references use the directory component List of references below your text or on a seperate page.