Skip to content

Commit

Permalink
Merge pull request #10 from maehr/develop
Browse files Browse the repository at this point in the history
docs
  • Loading branch information
maehr authored Sep 19, 2019
2 parents 6b90d85 + 8a68814 commit 1dd7151
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 23 deletions.
21 changes: 0 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,27 +34,6 @@ pandoc academic-pandoc-template.md --output academic-pandoc-template.pdf --from
pandoc academic-pandoc-template.md --output academic-pandoc-template.docx --from markdown+ascii_identifiers+tex_math_single_backslash+raw_tex+table_captions+yaml_metadata_block+autolink_bare_uris --pdf-engine xelatex --filter pandoc-citeproc --standalone
```

### Use with [typademic](https://github.com/maehr/typademic) on [Docker](https://docker.com) (EXPERT)

Install [Docker CE](https://www.docker.com/community-edition) and start a [typademic](https://github.com/maehr/typademic) instance.

#### Mac with [Homebrew](https://brew.sh/index_de)

```bash
brew install docker git
git clone [email protected]:maehr/typademic.git
docker-compose up
```

#### Ubuntu 16.04

```bash
sudo apt-get update
sudo apt-get install docker-ce git
git clone [email protected]:maehr/typademic.git
docker-compose up
```

## Support

This project is maintained by [@maehr](https://github.com/maehr). Please understand that we won't be able to provide individual support via email. We also believe that help is much more valuable if it's shared publicly, so that more people can benefit from it.
Expand Down
29 changes: 27 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,31 @@
layout: default
---

[Pandoc Markdown](./markdown.html)
## Getting Started

[GitHub](./github.html)
Make sure you have a Markdown editor like [Atom.io](https://atom.io/) and a Bibtex editor like [JabRef](http://www.jabref.org/) installed.

### Use with [typademic](https://typademic.ch) online (BEGINNER)

1. Download the [academic-pandoc-template](https://github.com/maehr/academic-pandoc-template/archive/master.zip)
2. Edit `/template/academic-pandoc-template.md` according to the [Markdown guide](https://maehr.github.io/academic-pandoc-template/markdown.html) with your favorite Markdown editor
3. Edit `/template/references.bib` with your favorite Bibtex editor
3. Upload all files in `/template/` to [typademic](https://typademic.ch) and convert it to PDF or Docx
4. Be happy!

If you need help with the GitHub check [this](./github.html) out.

### Use with Pandoc and Latex (ADVANCED)

Install all prerequisites

- [Pandoc](http://pandoc.org/installing.html) with [Pandoc Citeproc](https://github.com/jgm/pandoc-citeproc)
- [LaTeX](https://www.latex-project.org/get/)
- [Google Fonts](https://github.com/google/fonts)

Open your command line, navigate to `/template/` and execute the following commands.

```bash
pandoc academic-pandoc-template.md --output academic-pandoc-template.pdf --from markdown+ascii_identifiers+tex_math_single_backslash+raw_tex+table_captions+yaml_metadata_block+autolink_bare_uris --pdf-engine xelatex --filter pandoc-citeproc --standalone
pandoc academic-pandoc-template.md --output academic-pandoc-template.docx --from markdown+ascii_identifiers+tex_math_single_backslash+raw_tex+table_captions+yaml_metadata_block+autolink_bare_uris --pdf-engine xelatex --filter pandoc-citeproc --standalone
```

0 comments on commit 1dd7151

Please sign in to comment.