https://github.com/neurodata/marp-poster-template
Template for an academic poster using Marp
https://github.com/neurodata/marp-poster-template
Last synced: about 1 year ago
JSON representation
Template for an academic poster using Marp
- Host: GitHub
- URL: https://github.com/neurodata/marp-poster-template
- Owner: neurodata
- License: mit
- Created: 2022-04-12T17:20:47.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-10-28T13:59:40.000Z (over 3 years ago)
- Last Synced: 2023-03-11T22:07:46.584Z (over 3 years ago)
- Language: CSS
- Size: 24.5 MB
- Stars: 25
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Neurodata Marp Poster Template
## Setting up Marp
Instructions for using this [Marp](https://marp.app/) template in VSCode:
- Download [Marp extension for VSCode](https://marketplace.visualstudio.com/items?itemName=marp-team.marp-vscode).
- In VSCode `Preferences->Settings`, search Marp. Enable `Marp: Enable HTML`.
- Add our CSS theme to the list of markdown themes. This can be done by going into `.vscode/settings.json` and adding the css file to the list of Marp themes:
```
{
...
"markdown.marp.themes": [
"/poster.css"
]
...
}
```
where `` is the path relative to the folder that you have open in VSCode. Alternatively, you can add the path to `Preferences -> Settings` in the field called `Markdown › Marp: Themes`
For example, if you cloned this repo into a folder in VSCode, it would look like
```
{
"markdown.marp.themes": [
"./marp-poster-template/themes/poster.css"
],
}
```
## Creating the markdown to generate your poster
- Add the following header to your poster file (`.md`):
```
---
marp: true
theme: poster
paginate: false
size: 36:24
---
```
- You can automatically render your poster file using the preview preview pane with the `Markdown: Open preview` command.
- Note that you can change the `size:` option (this denotes width:height). Available sizes are listed at the top of `./theme/poster.css`; you can also create your own size.
## Exporting the poster
- The poster can be exported as `pdf`, `jpg`, `png`, and other formats supported by Marp.
- To export, click the Marp icon in the top right corner of the editor and choose `Export slide deck`. 
## Examples
