{"id":13395456,"url":"https://github.com/prat0318/json_resume","last_synced_at":"2025-05-15T03:05:39.309Z","repository":{"id":13526494,"uuid":"16217814","full_name":"prat0318/json_resume","owner":"prat0318","description":"Generates pretty HTML, LaTeX, markdown, with biodata feeded as input in JSON","archived":false,"fork":false,"pushed_at":"2018-06-18T07:08:57.000Z","size":2413,"stargazers_count":1359,"open_issues_count":9,"forks_count":116,"subscribers_count":32,"default_branch":"master","last_synced_at":"2025-04-21T03:51:01.473Z","etag":null,"topics":["cv","html","json","latex","resume"],"latest_commit_sha":null,"homepage":"http://prat0318.github.io/json_resume","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/prat0318.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-01-24T21:42:44.000Z","updated_at":"2025-04-15T09:23:00.000Z","dependencies_parsed_at":"2022-08-30T08:01:30.258Z","dependency_job_id":null,"html_url":"https://github.com/prat0318/json_resume","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prat0318%2Fjson_resume","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prat0318%2Fjson_resume/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prat0318%2Fjson_resume/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prat0318%2Fjson_resume/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/prat0318","download_url":"https://codeload.github.com/prat0318/json_resume/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254264765,"owners_count":22041793,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cv","html","json","latex","resume"],"created_at":"2024-07-30T17:01:59.776Z","updated_at":"2025-05-15T03:05:39.292Z","avatar_url":"https://github.com/prat0318.png","language":"Ruby","funding_links":[],"categories":["Ruby","Ruby (88)","latex"],"sub_categories":[],"readme":"# JsonResume\n\nJsonResume 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.\n\n## Installation\n\n    $ gem install json_resume\n\n## Usage\n\n### Create a sample JSON input file to start\n\n    $ json_resume sample\n\nA [sample](https://github.com/prat0318/json_resume/blob/master/examples/prateek_cv.json) `prateek_cv.json` is generated in the current working directory(cwd).\n\nModify it as per the needs, and remove or keep rest of the fields empty.\n\nNote: YAML files are also supported. Try `$ json_resume sample --in=yaml`.\n\n### Conversion\n\n* Syntax\n\n```\n    json_resume convert [--template=/path/to/custom/template]\n                        [--out=html|html_pdf|tex|tex_pdf|md]\n                        [--locale=es|en|ge|fi|pl|pt|zh_cn|ja]\n                        [--dest_dir=/path/to/put/output/files]\n                        [--theme=default|classic] \u003cjson_input\u003e\n\n    \u003cjson_input\u003e can be /path/to/json OR \"{'json':'string'}\" OR http://raw.json\n```\n\n    NEW: YAML files are also supported. Pass path/to/yaml file (must have .yaml or .yml).\n\n* Default (HTML) version\n\n```\n    $ json_resume convert prateek_cv.json\n```\n\nA directory `resume/` will be generated in cwd, which can be put hosted on /var/www or on github pages. ([Sample](http://prat0318.github.io/json_resume/html_version/resume_with_icons/))\n\n\n* HTML\\* version\n\n`html` version without icons can be generated by giving `icons` as `false` : ([Sample](http://prat0318.github.io/json_resume/html_version/resume_without_icons/))\n\n```\n     \"settings\": {\n         \"icons\" : false\n    },\n```\n\n* PDF version from HTML ([Sample](http://prat0318.github.io/json_resume/html_version/resume_with_icons/resume.pdf))\n\n```\n    $ json_resume convert --out=html_pdf prateek_cv.json\n```\n\n* LaTeX version ([Sample](https://www.writelatex.com/read/ynhgbrnmtrbw))\n\n```\n    $ json_resume convert --out=tex prateek_cv.json\n```\n\n  LaTex also includes a ``classic`` theme. Usage: ``--theme=classic`` ([Sample](https://www.writelatex.com/read/xscbhfpxwkqh)).\n\n* PDF version from LaTeX ([Sample](https://www.writelatex.com/read/ynhgbrnmtrbw))\n\n```\n    $ json_resume convert --out=tex_pdf prateek_cv.json\n```\n\n* Markdown version ([Sample](https://gist.github.com/prat0318/9c6e36fdcfd6a854f1f9))\n\n```\n    $ json_resume convert --out=md prateek_cv.json\n```\n\n## i18n Support\n\nSupport for ``en``, ``ge``, ``es``, ``fi``, ``pl`` and ``pt`` right now. Pull requests for others are welcome.\n\n```\n    $ json_resume convert --locale=es prateek_cv.json\n```\n\nIt is also possible to define a custom location for locale definitions.\nPass the option `--locale_dir=path/to/defs`.\nIn this location there should be the definitions available.\nThe default one is `en.yml`, others may be provided as well.\nThis is useful if you want to define new headings.\n\n## Markup Language\n\nJSON is parsed as per the `markdown` standards. This implies all this works-\n- \\*\\* **bold** \\*\\*,\n- \\_ _italics_ \\_,\n- script\u0026lt;sup\u0026gt;\u003csup\u003esup\u003c/sup\u003e\u0026lt;sup/\u0026gt;,\n- script\u0026lt;sub\u0026gt;\u003csub\u003esub\u003c/sub\u003e\u0026lt;sub/\u0026gt;,\n- \\[[href](#)\\]\\(#\\),\n- \u003c\u003c[http://github.com](http://github.com)\u003e\u003e\n\n## Customization\n\n#### Mustache Templates\n* Output is created using mustache templates. They are located in `templates/`. These can be modified and given as `--template=/path/to/template` to `convert`.\n\n#### Adding your own icons to json_resume\n1. Download the svg(s) you would like to use from a site like [IcoMoon](https://icomoon.io/app/) or [IconFinder](https://www.iconfinder.com) and chose size as 16X16.\n2. Download the official ``json_resume`` svgs from [the json_resume_icon repo zip](https://github.com/NoahHines/json_resume_icons/archive/master.zip). Unzip it, svgs are present in `/SVG`.\n3. Drag all svgs (including yours) onto the [grumpicon](http://www.grumpicon.com/) and then \"downlode it\".\n4. Drag all the files (``.css`` and ``.png``) from the ``grunticon`` folder into your local ``json_resume`` gem's folder ``json_resume-1.X.X/extras/resume_html/public/css/``, replacing existing files ([Read this](http://stackoverflow.com/questions/2827496/where-are-my-ruby-gems) to find your gem's location in your machine).\n5. Modify your HTML [mustache template](#mustache-templates) to include your icons. Specifically, edit the ``div`` class in the template to include your new grunticon (```\u003cdiv class=\"icon-user icon-square\"\u003e```, where \"user\" is the SVG name). You can also check grunticon's generated ``preview.html`` file to verify the icon class name.\n6. Run ``json_resume convert --template=/path/to/template \u003cjson\u003e``, and you should be able to see the changes in the generated HTML. Also, steps 1-5 are to be done just once and the icons will be stored within your local gem.\n\n## Changelog\n\n### v1.0\n* Glyphicons are now replaced by Font-Awesome icons.\n* HTML version has a responsive design.\n* Supports i18n. (Supporting ``es``, ``pt`` right now).\n* New classic theme for latex format.\n\n## Contributing\n\nMany awesome formats can be created by writing new mustache templates. We :heart: **Pull Requests**.\n\n1. Fork it\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create new Pull Request\n\n### Installation of local fork\nIf you want to checkout your local changes do the following:\n1. `gem build json_resume.gemspec`\n2. `sudo gem install ./json_resume-x.y.z.gem`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprat0318%2Fjson_resume","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprat0318%2Fjson_resume","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprat0318%2Fjson_resume/lists"}