robindemourat / zotermite

πŸ“– when markdown meets bibliography-making software zotero

Home Page:http://zotermite.herokuapp.com/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Zotermite - when markdown meets zotero

Zotermite screencast

Zotermite is an open-source app aimed at facilitating the use of academic references in markdown documents.

Does the previous sentence sound like a foreign language to your kind ears ? Well, then first check out what is Zotero and what is Markdown.

Zotermite can be used to generate markdown bibliographies, but also reading notes templates (the purpose for which I made it in the first place), and whatever your shiny imagination can produce.

Contributions are welcome, especially for the writing of additional standard templates. Send me a mail or pull-request the github for that !

Use zotermite : documentation

Check it directly in the app or find it at these addresses in this repo :

API service

Zotermite also features a mini API Service allowing you to dynamically process zotero items with its templating engine.

Here is the endpoint pattern :

POST /api/convert/:inputFormat/:template?

inputFormat : the format in which the data will be past. For now, it only supports the value zotero, which correspond to the native json objects served by the zotero API. Later, we could add other input formats, like bibtext for instance.

template : the built-in template to use to populate the response with input data.

The data to pass through your POST request must look like that :

{
    items : [array] // an array of the items to process,
    
    template : {string} //optional : if you want to use your own template, don't pass a template parameters and directly input its content as a string through this property
}

A successful answer you will get looks like that :

{
    template : {string} // the template that have been use to process your data

    items : [{
                item : [object] //the input data
                markdownContent : {string} //the input, populated content
            }]

    joinedContent : {string} //a string featuring all your outputs as one single text
}

Contribute !

Contributions are welcome, especially for writing additional standard templates (according to major bibliographic specs, common uses, ...).

About

πŸ“– when markdown meets bibliography-making software zotero

http://zotermite.herokuapp.com/


Languages

Language:JavaScript 72.8%Language:HTML 17.4%Language:CSS 9.7%