json_resume 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc754f327fd3923a9460bf11e43bee0f6ea9359c
-  data.tar.gz: 564a900c2d8f72f822f303ebb4ea43478009eddf
+  metadata.gz: 2a1173a0303dc190f3269138e43668f1a7d4ba80
+  data.tar.gz: dc227399cf697504bec342733fbe19b5c905f3c6
 SHA512:
-  metadata.gz: 922e9094c4edaabefa08f41685dfa632a6e66a18cd71956bdfb909cea38eab06e6f67bb9ee57655c15536a5701a89403a1301dc4c00953f3c08fbe05581cee10
-  data.tar.gz: 129ad2fb21e2ae4613194597de6851ebc546e6979da68f320819e4ca1d7d69b586c7e7e1fd3aae35a6166cc4ec4d3e4ede2bb298dad94247e2f15cfa75d7d242
+  metadata.gz: 21377dfa585ba9ae91f425c34fc38567b364760eefd7e0cb7ad005b2685b7feeda495682bebe9816f781fdf0e1d39228be16c5c4fcb721dcd72edc7570bf0b5f
+  data.tar.gz: 2bfd25dc904a6c54daabc75b44e48fe8ab058560160048b0aeff67e42c1314feebc880091e8560d0dfed7c83576b9c97a62a74579fd09b262dff5029d41b570d

data/README.md

@@ -1,6 +1,6 @@
 # JsonResume
 
-JsonResume helps in creating different versions of resume from a single JSON input file. It is different from present solutions as the output is more prettier and much customized to modern resume templates. Also, there is a ton of customization to the templates possible, to make your own version of resume created super quickly.
+JsonResume creates pretty versions of resume from a single JSON input file. Output formats are specifically customized to modern resume templates. Also, there are a ton of customizations to the templates possible, to make your own version of resume created easily and super quickly.
 
 ## Installation
 
@@ -12,48 +12,95 @@ JsonResume helps in creating different versions of resume from a single JSON inp
 
     $ json_resume sample
     
-A sample `prateek_cv.json` will be generated in the current working directory(cwd).
+A [sample](https://github.com/prat0318/json_resume/blob/master/examples/prateek_cv.json) `prateek_cv.json` is generated in the current working directory(cwd).
     
-Modify it as per your needs, and remove or keep rest of the fields empty.
+Modify it as per the needs, and remove or keep rest of the fields empty.
     
 ### Conversion
 
+* Syntax
+
+```
+    json_resume convert [--template=/path/to/custom/template] [--out=html|html_pdf|tex|tex_pdf|md] <json_input>
+
+    <json_input> can be /path/to/json OR "{'json':'string'}" OR http://raw.json
+```
+
 * Default (HTML) version
 
 ```
     $ json_resume convert prateek_cv.json
 ```
 
-A directory `resume/` will be generated in cwd, which can be put hosted on /var/www or on github pages.
+A directory `resume/` will be generated in cwd, which can be put hosted on /var/www or on github pages. ([Sample](http://prat0318.github.io/index1.html))
+
+
+* HTML\* version
+
+`html` version without glyphicons can be generated by giving `glyphicons` as `false` : ([Sample](http://prat0318.github.io/index2.html))
+
+```
+     "settings": {
+         "glyphicons" : false
+    },
+```
 
-* PDF version from HTML
+* PDF version from HTML ([Sample](http://prat0318.github.io/public/resume.pdf))
 
 ```
     $ json_resume convert --out=html_pdf prateek_cv.json
 ```
 
-* LaTeX version
+* LaTeX version ([Sample](https://www.writelatex.com/read/zkkbznbkfkgq))
 
 ```
     $ json_resume convert --out=tex prateek_cv.json
 ```
 
-* PDF version from LaTeX
+* PDF version from LaTeX ([Sample](https://www.writelatex.com/read/zkkbznbkfkgq))
 
 ```
     $ json_resume convert --out=tex_pdf prateek_cv.json
 ```
 
-* Markdown version
+* Markdown version ([Sample](https://gist.github.com/prat0318/9c6e36fdcfd6a854f1f9))
 
 ```
     $ json_resume convert --out=md prateek_cv.json
 ```
 
+## Markup Language
+
+JSON is parsed as per the `markdown` standards. This implies all this works-
+- \*\* **bold** \*\*, 
+- \_ _italics_ \_, 
+- script&lt;sup&gt;<sup>sup</sup>&lt;sup/&gt;,
+- script&lt;sub&gt;<sub>sub</sub>&lt;sub/&gt;, 
+- \[[href](#)\]\(#\), 
+- <<[http://github.com](http://github.com)>>
+
+## FAQs
+
+* I get the following error during `convert` :
+
+```
+Error:
+Generating the html type...
+/Users/myMac/.rvm/rubies/ruby-2.0.0-p353/lib/ruby/gems/2.0.0/gems/json-1.8.1/lib/json/common.rb:155:in `encode': "\xE2" on US-ASCII (Encoding::InvalidByteSequenceError)
+        from /Users/abhiramk/.rvm/rubies/ruby-2.0.0-p353/lib/ruby/gems/2.0.0/gems/json-1.8.1/lib/json/common.rb:155:in `initialize'
+        from /Users/abhiramk/.rvm/rubies/ruby-2.0.0-p353/lib/ruby/gems/2.0.0/gems/json-1.8.1/lib/json/common.rb:155:in `new'
+```
+
+Looks like locale problem. Add the following to the environment : `export LC_CTYPE=en_US.UTF-8` ( Thanks to [@viswamitra](https://github.com/viswamitra) )
+
 ## Customization
 
+Output is creating using mustache templates. They are located in `templates/`. These can be modified and given as `--template=/path/to/template` to `convert`. For example, the tex template was customized to produced [this new format](https://www.writelatex.com/read/tktqrbmhnyqp).
+
 ## Contributing
 
+Many awesome formats can be created by writing new mustache templates. We :heart: **Pull Requests**.
+
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)

data/lib/json_resume/formatter.rb

@@ -22,6 +22,7 @@ module JsonResume
 		end
 
     def add_linkedin_github_url
+      @hash["raw_website"] = @hash["bio_data"]["website"].sub(/^https?:\/\//,'') if @hash["bio_data"] && @hash["bio_data"]["website"]
       @hash["linkedin_url"] = "http://linkedin.com/in/" + @hash["linkedin_id"] if @hash["linkedin_id"]
       @hash["github_url"] = "http://github.com/" + @hash["github_id"] if @hash["github_id"]
     end

data/lib/json_resume/version.rb

@@ -1,3 +1,3 @@
 module JsonResume
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

data/templates/default_tex.mustache

@@ -12,9 +12,9 @@
 \title{\small <%#stars%><%#items%><%name%><%^last%> $\star$ <%/last%><%/items%><%/stars%>}
 <%#phone%>\phone{<%.%>}<%/phone%>
 <%#email%>\email{<%.%>}<%/email%>
-<%#website%>\homepage{<%& .%>}<%/website%>
-<%#linkedin_url%>\social[linkedin]{<%& .%>}<%/linkedin_url%>
-<%#github_url%>\social[github]{<%& .%>}<%/github_url%>
+<%#raw_website%>\homepage{<%& .%>}<%/raw_website%>
+<%#linkedin_id%>\social[linkedin]{<%& .%>}<%/linkedin_id%>
+<%#github_id%>\social[github]{<%& .%>}<%/github_id%>
 
 % the ConTeXt symbol
 \def\ConTeXt{%

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_resume
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Prateek Agarwal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-05 00:00:00.000000000 Z
+date: 2014-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler