From 8a688148a30bc7936e2869d62ce599c1f794c068 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Moritz=20M=C3=A4hr?= Date: Thu, 19 Sep 2019 10:37:28 +0200 Subject: [PATCH] docs --- README.md | 21 --------------------- docs/index.md | 29 +++++++++++++++++++++++++++-- 2 files changed, 27 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 245a32b..004c4d6 100644 --- a/README.md +++ b/README.md @@ -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 git@github.com:maehr/typademic.git -docker-compose up -``` - -#### Ubuntu 16.04 - -```bash -sudo apt-get update -sudo apt-get install docker-ce git -git clone git@github.com: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. diff --git a/docs/index.md b/docs/index.md index 7aa83b0..b3a0a73 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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 +```