Permalink
Cannot retrieve contributors at this time
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
reMarkAble/README.md
Go to fileThis commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
108 lines (61 sloc)
1.41 KB
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# Marking in Markdown | |
Working Title Dans Marking Compiler | |
Use Markdown for the Input (Have a semi stuctured file) | |
Use Markdown AST to parse | |
Jinja for output | |
Python commonmark will give me the AST | |
## Setup | |
If not already | |
``` | |
python -m venv env | |
``` | |
python setup.py develop | |
## Tests | |
``` | |
pip install pytest | |
pytest | |
``` | |
Or to stop and capture outputs | |
``` | |
pytest -x -s | |
``` | |
Or Nicer HTML output | |
pytest --html=report.html | |
## Running | |
There is a command line interface through the ```runDMC``` command | |
``` | |
runDMC <input> [-t template] [-d dir for local templates] [-o output file] | |
``` | |
If no output file is specified, we generate <input>.html | |
## Built In Templates | |
- EEC Coursework Brief. | |
## Examples | |
Can be found in the examples directory | |
We have an example of a [coursework Brief](examples/CourseworkBrief.md) | |
Using the built in template | |
Render with | |
``` | |
$examples runDMC CourseworkBrief.md -t CourseworkBrief.jinja2 | |
``` | |
## TODO | |
Paths / Organisation for the Templates do it | |
- templates/ | |
- template1.jinja | |
- template2.jinja | |
- templates/ | |
- Type | |
- template1.jinja | |
The second is better for orgnaisation, but a makes the command line clunky. | |
We could map in the main function though... | |
## Documentation | |
Can be found <here> | |
Generated with MKDocs | |
To regenerate the docs | |
~~~ | |
#Install | |
$pip install mkdocs | |
#Build (in the docs directory) | |
docs$ mkdocs build | |
#Preview | |
docs$ mkdocs serve | |
~~~ |