Skip to content

Commit

Permalink
Fixing MD
Browse files Browse the repository at this point in the history
  • Loading branch information
NickCH-K committed Dec 15, 2018
1 parent a14a046 commit 603634f
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 9 deletions.
8 changes: 8 additions & 0 deletions README
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
CVRoller
=========

This is a script designed to be a generic automatic document compiling language, with an eye on catering to the creation of CVs.

The goal is to have a format for writing document layout structures and data (including from spreadsheet, JSON, .bib, or sites like ORCID or PubMed), then reading in both and spitting out any number of varieties of CV (including website, PDF, and Word).

This project is under construction. Soon it will be to the point where it's basically usable (at least on the base level), but without implementation of some features that may come in handy, and which requires learning the layout language to use. Eventually the goal is to have a system that's easy to use without having to learn too much.
8 changes: 2 additions & 6 deletions SpreadsheetInstructions.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
---
title: How to Write a CVRoller Data File
author: Nick Huntington-Klein
---

#How to Write a CVRoller Spreadsheet File
How to Write a CVRoller Spreadsheet File
========================================

A CVRoller spreadsheet file, identified by the `file` option in the CVRoller Layout file, contains all the necessary information that will be laid out in the CV.

Expand Down
6 changes: 3 additions & 3 deletions fixesandfeatures.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Near Term Fixes and Features
----------------------------
============================

Small Fixes/Features
====================
--------------------
* Allow layout file to have two different versions of the same-named section
* Improve method for reading in options and layout structure
* Allow commas in version options
Expand All @@ -19,7 +19,7 @@ Small Fixes/Features
*Add LaTeX-out and pandoc-out

Big Fixes/Features
==================
------------------
* recognize citation sections by looking for a s['citestyle'] argument and run the relevant attributes through a CSL to generate the item. This may require pandoc and/or routing through BiBTeX first? Note: https://www.chriskrycho.com/2015/academic-markdown-and-citations.html
* Allow theming! Native themes specific to CVRoller (this actually would be a small fix), or, ideally, working with other CV themes like markdown-cv http://elipapa.github.io/markdown-cv/ or LaTeX moderncv https://www.ctan.org/pkg/moderncv. Add theme option to versions.

Expand Down

0 comments on commit 603634f

Please sign in to comment.