wnagrodzki/AppleDocumentationStyleLatexTemplate
1
0
Fork 0
mirror of https://github.com/wnagrodzki/AppleDocumentationStyleLatexTemplate.git synced 2025-05-07 03:21:43 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updates readme file.

Browse source
This commit is contained in:
Wojciech Nagrodzki 2015-09-16 20:54:42 +02:00
parent 5f52b34b8d
commit 5208f742e4
Signed by: wnagrodzki
GPG key ID: E9D0EB0302264569
1 changed files with 34 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

63
README.md
View file

@ -1,32 +1,37 @@
Apple Documentation Style - LaTeX Template Overview
==================================== ====================================
This LaTeX template will let you create beautiful PDF documents inspired by Apple documentations.
To enable syntax highlighting you need to install Pygments and use xelatex for compilation:
1. sudo easy_install Pygments
2. xelatex -file-line-error -synctex=1 -shell-escape -interaction=nonstopmode "File.tex"
To integrate the template with TeXShop:
1. navigate to ~/Library/TeXShop/Engines
2. open XeLaTeX.engine file
3. add two additional parameters -shell-escape -interaction=nonstopmode
Table Of Contents
![Table Of Contents](https://raw.github.com/wnagrodzki/AppleDocumentationStyleLatexTemplate/master/Screen%20Shots/TOC.png "Table Of Contents")
Sections, subcection, and subsubsections style
![Sections, subsections](https://raw.github.com/wnagrodzki/AppleDocumentationStyleLatexTemplate/master/Screen%20Shots/Sections.png "Sections, subsections")
Code listing
![Code listing](https://raw.github.com/wnagrodzki/AppleDocumentationStyleLatexTemplate/master/Screen%20Shots/Codelisting.png "Code listing")
- [ ] Title page - [ ] Title page
- [x] Table of contents - [x] Table of contents
- [x] Section, subcectio, and subsubsection style - [x] Chapter, section, and subsection headings
- [x] Code listing - [x] Objective-C code listing with syntax highlighting
- [x] Syntax highlighting - [x] Swift code listing with syntax highlighting
How To Get Started
====================================
1. Install [MacTex](https://www.github.com)
1. Check if there are any updates for TeXShop and TeX Live Utility applications
2. Launch TeX Live Utility and update all packages
2. Integrate the template with TeXShop
1. Navigate to ~/Library/TeXShop/Engines
2. Open XeLaTeX.engine file
3. Add two additional parameters -shell-escape -interaction=nonstopmode
3. Install [Pygments](http://pygments.org)
1. sudo easy_install Pygments
In case of commandline compilation, use xelatex
```
xelatex -file-line-error -synctex=1 -shell-escape -interaction=nonstopmode "File.tex"
```
Screenshots
====================================
![Table Of Contents](https://raw.github.com/wnagrodzki/AppleDocumentationStyleLatexTemplate/master/Screen%20Shots/TOC.png)
![Sections, subsections](https://raw.github.com/wnagrodzki/AppleDocumentationStyleLatexTemplate/master/Screen%20Shots/Sections.png)
![Objective-C listing](https://raw.github.com/wnagrodzki/AppleDocumentationStyleLatexTemplate/master/Screen%20Shots/CodelistingObjC.png)
![Swift listing](https://raw.githubusercontent.com/wnagrodzki/AppleDocumentationStyleLatexTemplate/master/Screen%20Shots/CodelistingSwift.png)