Skip to content

Commit

Permalink
Use ORCID logo from code
Browse files Browse the repository at this point in the history
Deprecates  YAML option, fixes #14
  • Loading branch information
mvuorre committed Nov 27, 2024
1 parent 7bc38a6 commit 51da762
Show file tree
Hide file tree
Showing 6 changed files with 17 additions and 56 deletions.
11 changes: 4 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
*quarto-preprint* is a [Quarto](https://quarto.org) extension for rendering Quarto source documents to PDF documents via [Typst](https://typst.app/docs). It aims to

- Just Work™️
- Typst doesn't require complicated LaTeX installations
- Typst doesn't require complicated LaTeX installations
- Be fast
- Typst creates PDF files very quickly
- Be 100% Quarto standards compliant
- Write manuscripts without worrying about formatting & metadata
- Switch to any Quarto journal format without changing anything but `format:` (and whatever is required by the destination format)

To use (see below), install the extension and set your Quarto output format to `preprint-typst`. The extension also provides a `preprint-docx` format, which renders Quarto source documents to MS Word documents with some basic layout improvements.
To use (see below), install the extension and set your Quarto output format to `preprint-typst`. The extension also provides a `preprint-docx` format, which renders Quarto source documents to MS Word documents with some basic layout improvements.

Example output: <https://mvuorre.github.io/quarto-preprint/index.pdf>.

Expand Down Expand Up @@ -36,14 +36,11 @@ The output of Quarto documents is configured through YAML metadata either in the

```{yaml}
running-head: "*preprint* Quarto extension manual"
branding: psyarxiv
authornote: This is an example author note.
wordcount: "{{< words-body >}}"
```

`running-head` should be a text string and is used as the document's running head.

`branding` adds a specified preprint service's logo to the document. Currently only "psyarxiv" is a valid value.
`running-head` should be a text string and is used as the document's running head.

`authornote` allows adding information to the footer of the first page.

Expand All @@ -57,7 +54,7 @@ wordcount: "{{< words-body >}}"

## Contributing

Send your bug reports and pull requests to <https://github.com/mvuorre/quarto-preprint>. If you're reporting a bug, please include a reproducible example / full details of what you're trying to do, how, and what goes wrong.
Send your bug reports and pull requests to <https://github.com/mvuorre/quarto-preprint>. If you're reporting a bug, please include a reproducible example / full details of what you're trying to do, how, and what goes wrong.

## Tips

Expand Down
6 changes: 2 additions & 4 deletions _extensions/preprint/_extension.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,19 @@ author: Matti Vuorre
version: 0.10.2
quarto-required: ">=1.5.47"
contributes:
shortcodes:
shortcodes:
- "_extensions/andrewheiss/wordcount/words.lua"
formats:
typst:
template-partials:
- typst-template.typ
- typst-show.typ
format-resources:
- '*.svg'
citeproc: false
filters:
- at: pre-quarto
path: _extensions/andrewheiss/wordcount/citeproc.lua
- at: pre-quarto
path: _extensions/andrewheiss/wordcount/wordcount.lua
count-code-blocks: false
docx:
docx:
reference-doc: preprint.docx
17 changes: 0 additions & 17 deletions _extensions/preprint/orcid.svg

This file was deleted.

Loading

0 comments on commit 51da762

Please sign in to comment.