LaTeX
/
metropolis_theme
mirror of https://github.com/matze/mtheme.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Re-organize README

This commit is contained in:
Matthias Vogelgesang 2015-06-02 08:29:48 +02:00
parent 99a5f6260e
commit 05fa08c37e
1 changed files with 30 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

63
README.md
View File

@ -2,13 +2,11 @@
The *mtheme* is a Beamer theme with minimal visual. The core design principles The *mtheme* is a Beamer theme with minimal visual. The core design principles
of the theme were described in a [blog post](http://bloerg.net/2014/09/20/a-modern-beamer-theme.html). of the theme were described in a [blog post](http://bloerg.net/2014/09/20/a-modern-beamer-theme.html).
Not convinced? Have a look at the [demo slides](demo.pdf). Not convinced? Have a look at the [demo slides](demo.pdf).
![Sample](http://i.imgur.com/Bxu52fz.png) ![Sample](http://i.imgur.com/Bxu52fz.png)
### Installation ### Installation
To install the theme either run `make install` or copy the style files ending To install the theme either run `make install` or copy the style files ending
@ -26,12 +24,14 @@ the `contrib/` directory for more. Users of Debian or Ubuntu can also install
[this .deb package](https://launchpad.net/~edd/+archive/ubuntu/misc/+files/latex-mtheme_0.1.0vidid1_all.deb) [this .deb package](https://launchpad.net/~edd/+archive/ubuntu/misc/+files/latex-mtheme_0.1.0vidid1_all.deb)
containing the theme files as well as the Fira Sans font files. containing the theme files as well as the Fira Sans font files.
To build the demo slides run
### Usage $ make
To build the demo slides just run `make` in the top-level directory. To use this in the top-level directory.
theme with [Pandoc](http://johnmacfarlane.net/pandoc/)-based presentations, you
can run the following command To use this theme with [Pandoc](http://johnmacfarlane.net/pandoc/)-based
presentations, you can run the following command
$ pandoc -t beamer --latex-engine=xelatex -V theme:m -o output.pdf input.md $ pandoc -t beamer --latex-engine=xelatex -V theme:m -o output.pdf input.md
@ -40,35 +40,32 @@ can run the following command
#### Package options #### Package options
To use any of options below, call them when invoking *mtheme* in the header of To use any of options below, call them when invoking *mtheme* in the preabmle of
your document: `\usetheme[<options>]{m}` the slides, i.e.
The `usetitleprogressbar` option adds a thin progress bar similar to the section ```latex
progress bar underneath *each* frame title \usetheme[<options>]{m}
```
* The `usetitleprogressbar` option adds a thin progress bar similar to the
section progress bar underneath *each* frame title
![Progressbar](http://i.imgur.com/4BXHU4K.png) ![Progressbar](http://i.imgur.com/4BXHU4K.png)
* In order to use `\cite`, `\ref` and similar commands in a frame title you have
In order to use `\cite`, `\ref` and similar commands in a frame title you have to protect the title. This can be done automatically with the
to protect the title. This can be done automatically with the `protectframetitle` option.
`protectframetitle` option. * The `blockbg` option defines extra colors used in defining the blocks. The
blocks then have a gray background similar to other beamer themes.
The `blockbg` option defines extra colors used in defining the blocks. * By default, this package adds `\vspace{2em}` after the frametitle to center
The blocks then have a gray background similar to other beamer themes. content vertically on the frame. If using more content per slide, this can be
turned off at the package-level by passing the `nooffset` option.
By default, this package adds `\vspace{2em}` after the frametitle to * With option `nosectionslide`, no dedicated slide is produced when a new
make content more centered on the frame. If using more content per section starts. By default when using the `\section` command, a slide is
slide, this can be turned off at the package-level by passing the created with just the title on it.
`nooffset` option. * Option `usetotalslideindicator` creates slide numbering in lower right corner
in following format: #current/#total. By default, just current page number is
With option `nosectionslide`, no dedicated slide is produced when a new section printed.
starts. By default when using the `\section` command, a slide is created with * Option `noslidenumbers` omits slide numbers entirely.
just the title on it.
Option `usetotalslideindicator` creates slide numbering in lower right corner
in following format: #current/#total. By default, just current page number is
printed.
Option `noslidenumbers` omits slide numbers entirely.
#### Title formatting #### Title formatting