Parcourir la source

Adding docs + typo fix

Swaroop C H il y a 12 ans
Parent
commit
6402368ddb
2 fichiers modifiés avec 8 ajouts et 2 suppressions
  1. 7 1
      README.md
  2. 1 1
      fabfile.py

+ 7 - 1
README.md

@@ -9,7 +9,7 @@ Install `pdflatex` from <http://www.tug.org/texlive/>.
 Note that Mac users can install `MacTex.pkg` from <http://www.tug.org/mactex/2012/>.
 
 Install `pip` if not present already:
-    
+
     sudo sh -c "curl -k -O https://raw.github.com/pypa/pip/master/contrib/get-pip.py && python get-pip.py && rm get-pip.py"
 
 
@@ -21,3 +21,9 @@ Install Python libraries needed:
 Convert the source files into HTML files:
 
     fab html
+
+## Editing
+
+If you're using Vim editor, then installing [vim-pandoc](https://github.com/vim-pandoc/vim-pandoc) plugin is recommended.
+
+If you're using [Sublime Text](http://www.sublimetext.com/) editor, you may find [Sublime Package Control](http://wbond.net/sublime_packages/package_control/installation) and [Pandoc Academic](https://github.com/larlequin/PandocAcademic) plugins useful.

+ 1 - 1
fabfile.py

@@ -319,7 +319,7 @@ def pdf():
             # https://github.com/jgm/pandoc/issues/571
             #'-t', 'pdf',
             '-o', '{}.pdf'.format(FULL_PROJECT_NAME)] + \
-        + [i['file'] for i in MARKDOWN_FILES]
+        [i['file'] for i in MARKDOWN_FILES]
     local(' '.join(args))
     if AWS_ENABLED:
         upload_output_to_s3('{}.pdf'.format(FULL_PROJECT_NAME))