-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathindex.html
404 lines (377 loc) · 18 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
<!DOCTYPE html>
<html>
<head>
<title>Home - Citation.js</title>
<meta name="description" content="Citation.js converts formats like BibTeX, Wikidata JSON and ContentMine JSON to CSL-JSON to convert to other formats like APA, Vancouver and back to BibTeX." />
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0" />
<meta name="theme-color" content="#FFC107" />
<meta name="google-site-verification" content="CzUIXxrEXTZ3WQWM6VysvxyJ1OI1ExZtPqbVwbS5Obk" />
<link rel="me" href="https://fosstodon.org/@citationjs" />
<link rel="shortcut icon" type="image/png" href="/favicon.png" />
<link rel="icon" type="image/png" href="/favicon.png" />
<link rel="stylesheet" type="text/css" href="https://fonts.googleapis.com/css?family=Roboto:regular,bold,italic,bolditalic&lang=en" />
<link rel="stylesheet" type="text/css" href="https://fonts.googleapis.com/icon?family=Material+Icons" />
<link rel="stylesheet" type="text/css" href="/static/css/style.css" />
<script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.4/jquery.min.js"></script>
<script type="text/javascript" src="/static/js/highlight.js"></script>
<script>$(function(){
$('pre code[data-type]').highlight()
$('.code').load('/static/code.html', function () {
$('.code pre code').highlight()
})
})</script>
</head>
<body>
<nav>
<div class="background"></div>
<div>
<a href="/">Citation.js</a>
<a href="/blog/">Blog</a>
<a href="/demo/">Demo</a>
<a href="/api/0.7">Docs</a>
</div>
</nav>
<header>
<div class="background code" role="presentation"></div>
<h1>
<img src="/static/img/banner-full.png" width="502" />
</h1>
<section>
<p>
Citation.js (<a href="https://github.com/citation-js/citation-js">GitHub</a>,
<a href="https://www.npmjs.org/package/@citation-js/core">NPM</a>)
converts formats like BibTeX, BibJSON, DOI, and Wikidata to CSL-JSON to convert
to styles like APA, Vancouver and to BibTeX and RIS.
</p>
<p>
Read the paper <a href="https://peerj.com/articles/cs-214/?td=bl">
<i>Citation.js: a format-independent, modular bibliography tool for the browser and command line</i>
<img src="https://img.shields.io/badge/DOI-10.7717%2Fpeerj--cs.214-blue"
alt="DOI 10.7717/peerj-cs.214"
style="vertical-align: middle;" />
</a>.
</p>
<p>
<a class="badge" href="https://www.npmjs.org/package/@citation-js/core">
<img height="20" src="https://img.shields.io/npm/v/@citation-js/core.svg" alt="NPM version">
</a>
<a class="badge" href="https://npm-stat.com/charts.html?package=@citation-js/core&from=2016-10-10">
<img height="20" src="https://img.shields.io/npm/dy/@citation-js/core.svg" alt="NPM total downloads">
</a>
<a class="badge" href="https://www.jsdelivr.com/package/npm/citation-js?tab=stats">
<img height="20" src="https://img.shields.io/jsdelivr/npm/hy/citation-js" alt="jsDelivr hits">
</a>
<a class="badge" href="https://github.com/citation-js/citation-js/actions?query=workflow%3Abuild">
<img height="20" src="https://img.shields.io/github/actions/workflow/status/citation-js/citation-js/build.yml?branch=main" alt="Build Status">
</a>
</p>
</section>
</header>
<article>
<div>
<section id="features">
<h2>Features</h2>
<ul>
<li><a href="#supported-formats">
Modular approach: select which formats to include
</a></li>
<li>Convenient wrapper some of the most common modules</li>
<li>Preloaded styles and locales for formatted references</li>
<li>Support for Node.js and the browser</li>
<li>A command-line interface (CLI)</li>
<li>MIT licensed</li>
</ul>
</section>
<section id="getting-started">
<h2>Getting started</h2>
<h3>Install</h3>
<pre><code><span class="comment">$</span> <span class="native">npm install</span> @citation-js/core @citation-js/plugin-doi @citation-js/plugin-doi</code></pre>
<h3>Usage</h3>
<pre><code data-type="js">// Load Citation.js
const { Cite } = require('@citation-js/core')
// Load plugins
require('@citation-js/plugin-doi')
require('@citation-js/plugin-csl')
// Parse input
Cite.async('10.7717/peerj-cs.214').then(data => {
// Format output
const bibliography = data.format('bibliography', {
format: 'html',
template: 'apa',
lang: 'en-US'
})
console.log(bibliography)
})</code></pre>
</section>
<section id="supported-formats">
<h2>Supported input and output</h2>
<h3>Identifiers</h3>
<div class="table-container">
<table>
<thead align="left">
<th>Formats</th>
<th>Resolver</th>
<th>Plugin</th>
</thead>
<tbody>
<tr>
<td><a href="https://en.wikipedia.org/wiki/Digital_object_identifier">DOIs (Digital Object Identifiers)</a></td>
<td><a href="https://citation.crosscite.org/docs.html">DOI Content Negotiation</a></td>
<td><a href="https://npmjs.com/@citation-js/plugin-doi">@citation-js/plugin-doi</a></td>
</tr>
<tr>
<td><a href="https://en.wikipedia.org/wiki/ISBN">ISBNs</a></td>
<td>
<a href="https://developers.google.com/books/docs/v1/reference/volumes/get">Google Books API</a>,
<a href="https://openlibrary.org/dev/docs/api/books">OpenLibrary API</a>
</td>
<td><a href="https://npmjs.com/@citation-js/plugin-isbn">@citation-js/plugin-isbn</a></td>
</tr>
<tr>
<td>
<a href="https://en.wikipedia.org/wiki/PubMed_ID">PubMed</a> and
<a href="https://en.wikipedia.org/wiki/PMCID">PMC</a> identifiers
</td>
<td><a href="https://api.ncbi.nlm.nih.gov/lit/ctxp">NCBI's Literature Citation Explorer</a></td>
<td><a href="https://npmjs.com/@citation-js/plugin-pubmed">@citation-js/plugin-pubmed</a></td>
</tr>
<tr>
<td><a href="https://en.wikipedia.org/wiki/Wikidata">Wikidata QIDs</a></td>
<td><a href="https://www.wikidata.org/w/api.php">Wikidata MediaWiki API</a></td>
<td><a href="https://npmjs.com/@citation-js/plugin-wikidata">@citation-js/plugin-wikidata</a></td>
</tr>
<tr>
<td>
<a href="https://github.com">GitHub</a> repository URLs and
<a href="https://npmjs.com">npm</a> package URLs
</td>
<td>
<a href="https://docs.github.com/en/rest">GitHub v3 API</a> and
<a href="https://docs.npmjs.com/cli/v8/using-npm/registry">npm registry</a>
</td>
<td><a href="https://npmjs.com/@citation-js/plugin-software-formats">@citation-js/plugin-software-formats</a></td>
</tr>
</tbody>
</table>
</div>
<h3>File formats</h3>
<div class="table-container">
<table>
<thead align="left">
<th>Formats</th>
<th>Input</th>
<th>Output</th>
<th>Plugin</th>
</thead>
<tbody>
<tr>
<td>JSON</td>
<td><i class="material-icons">check_circle</i></td>
<td><i class="material-icons">check_circle</i></td>
<td>—</td>
</tr>
<tr>
<td>
<a href="https://github.com/citation-style-language/schema/blob/master/schemas/input/csl-data.json">CSL-JSON</a>
</td>
<td><i class="material-icons">check_circle</i></td>
<td><i class="material-icons">check_circle</i></td>
<td>—</td>
</tr>
<tr>
<td><a href="https://okfnlabs.org/bibjson/">BibJSON</a></td>
<td><i class="material-icons">check_circle</i></td>
<td><i class="material-icons">highlight_off</i></td>
<td><a href="https://npmjs.com/@citation-js/plugin-bibjson">@citation-js/plugin-bibjson</a></td>
</tr>
<tr>
<td>
Formatted bibliographies and citations with
<a href="https://citationstyles.org/">CSL</a> and
<a href="https://github.com/Juris-M/citeproc-js">citeproc-js</a>
</td>
<td><i class="material-icons">highlight_off</i></td>
<td><i class="material-icons">check_circle</i></td>
<td><a href="https://npmjs.com/@citation-js/plugin-csl">@citation-js/plugin-csl</a></td>
</tr>
<tr>
<td>
<a href="https://en.wikipedia.org/wiki/BibTeX">BibTeX</a>,
<a href="https://en.wikipedia.org/wiki/Biber_(LaTeX)">BibLaTeX</a>,
<a href="https://bibtxt.github.io/">Bib.TXT</a>
</td>
<td><i class="material-icons">check_circle</i></td>
<td><i class="material-icons">check_circle</i></td>
<td><a href="https://npmjs.com/@citation-js/plugin-bibtex">@citation-js/plugin-bibtex</a></td>
</tr>
<tr>
<td>
<a href="https://en.wikipedia.org/wiki/EndNote#Import_format"><code>.enw</code> files</a>
</td>
<td><i class="material-icons">check_circle</i></td>
<td><i class="material-icons">check_circle</i></td>
<td><a href="https://npmjs.com/@citation-js/plugin-enw">@citation-js/plugin-enw</a></td>
</tr>
<tr>
<td>
<a href="https://github.com/typst/hayagriva">Hayagriva</a>
(from <a href="https://typst.app/">Typst</a>)
</td>
<td><i class="material-icons">check_circle</i></td>
<td><i class="material-icons">check_circle</i></td>
<td><a href="https://npmjs.com/@citation-js/plugin-hayagriva">@citation-js/plugin-hayagriva</a></td>
</tr>
<tr>
<td><a href="https://www.wikidata.org/wiki/Help:QuickStatements#Command_sequence_syntax">QuickStatements v1</a></td>
<td><i class="material-icons">highlight_off</i></td>
<td><i class="material-icons">check_circle</i></td>
<td><a href="https://npmjs.com/@citation-js/plugin-quickstatements">@citation-js/plugin-quickstatements</a></td>
</tr>
<tr>
<td><a href="https://en.wikipedia.org/wiki/RIS_(file_format)">RIS</a> (1st and 2nd version)</td>
<td><i class="material-icons">check_circle</i></td>
<td><i class="material-icons">check_circle</i></td>
<td><a href="https://npmjs.com/@citation-js/plugin-ris">@citation-js/plugin-ris</a></td>
</tr>
<tr>
<td><a href="https://en.wikipedia.org/wiki/Refer_(software)">refer</a> file format</td>
<td><i class="material-icons">check_circle</i></td>
<td><i class="material-icons">check_circle</i></td>
<td><a href="https://npmjs.com/@citation-js/plugin-refer">@citation-js/plugin-refer</a></td>
</tr>
<tr>
<td><a href="https://en.wikipedia.org/wiki/RefWorks">RefWorks</a> tagged format</td>
<td><i class="material-icons">check_circle</i></td>
<td><i class="material-icons">check_circle</i></td>
<td><a href="https://npmjs.com/@citation-js/plugin-refworks">@citation-js/plugin-refworks</a></td>
</tr>
<tr>
<td>
<a href="https://citation-file-format.github.io/">CFF (Citation File Format)</a>,
<a href="https://developers.zenodo.org/#depositions">Zenodo Deposit JSON</a>
</td>
<td><i class="material-icons">check_circle</i></td>
<td><i class="material-icons">check_circle</i></td>
<td><a href="https://npmjs.com/@citation-js/plugin-software-formats">@citation-js/plugin-software-formats</a></td>
</tr>
<tr>
<td>
<a href="https://en.wikipedia.org/wiki/Template:Citation_Style_documentation/cs1">Citation Style 1 templates</a>
of the English Wikipedia
</td>
<td><i class="material-icons">highlight_off</i></td>
<td><i class="material-icons">check_circle</i></td>
<td><a href="https://npmjs.com/@citation-js/plugin-wikipedia-templates">@citation-js/plugin-wikipedia-templates</a></td>
</tr>
</tbody>
</table>
</div>
</section>
<section id="usage">
<h2>Usage</h2>
<ul>
<li>
<a href="https://github.com/citation-js/replacer">@citation-js/replacer</a>,
a simple HTML API for <b>Citation.js</b>, to format citations
on your page as easily as possible.
</li>
<li>
<a href="https://github.com/citation-js/isaac-chrome-extension">ISAAC Chrome Extension</a>,
a web extension to aid the entry of data regarding publications
on the Dutch NWO ISAAC platform.
</li>
<li>
<a href="https://citation-js.github.io/bibtex-generator/">BibTeX generator</a>,
easily generate a BiTeX file from various inputs.
</li>
</ul>
<h3>In the wild</h3>
<ul>
<li>
<a href="https://github.com/pubpub/pubpub">PubPub</a>, a platform for
open publishing.
</li>
<li>
<a href="https://scholia.toolforge.org/">Scholia</a>, an interface
that displays and augments data from Wikidata.
</li>
<li>
<a href="https://github.com/wikicite/wcite">wcite</a>, a CLI for
fetching and managing bibliographic records from Wikidata.
</li>
<li>
<a href="https://github.com/rmzelle/ref-extractor">Reference Extractor</a>,
an online tool to extract references from Microsoft Word and LibreOffice documents.
</li>
<li>
<a href="https://forgejo.org/">Forgejo</a>,
a self-hosted Git server.
</li>
</ul>
</section>
<section id="alternatives">
<h2>Similar projects & alternatives</h2>
<ul>
<li>
<a href="https://github.com/Juris-M/citeproc-js">citeproc-js</a>,
the definitive implementation of <a href="https://citationstyles.org/">CSL</a>
(also used by <b>@citation-js/plugin-csl</b>).
</li>
<li>
<a href="https://zotero.org">Zotero</a>, a manager application for
references and associated files, with an extensive set of parsers and
scrapers.
</li>
<li>
<a href="https://github.com/dsifford/astrocite/">astrocite</a>, a collection
of parsers that output CSL-JSON.
</li>
<li>
<a href="https://github.com/retorquere/bibtex-parser/">Better BibTeX' bibtex-parser</a>,
an impressively extensive Bib(La)TeX parser.
</li>
<li>
<a href="https://www.jabref.org/">JabRef</a>, a BibTeX-based reference manager.
</li>
<li>
The <a href="https://github.com/fiduswriter/biblatex-csl-converter">Bib(La)TeX to CSL converter</a>
from <a href="https://fiduswriter.org/">Fidus Writer</a>.
</li>
</ul>
</section>
<section id="cite">
<h2>How to cite</h2>
<blockquote>
Willighagen, L. G. (2019). Citation.js: a format-independent, modular bibliography tool for the browser and command line. <i>PeerJ Computer Science</i>, 5, e214.
<a href="https://doi.org/10.7717/peerj-cs.214">https://doi.org/10.7717/peerj-cs.214</a>
</blockquote>
</section>
<aside>
<section>
<h2>Contents</h2>
<nav>
<ul>
<li><a href="#features">Features</a></li>
<li><a href="#getting-started">Getting started</a></li>
<li><a href="#supported-formats">Supported input and output</a></li>
<li><a href="#usage">Usage</a></li>
<li><a href="#alternatives">Similar projects & alternatives</a></li>
<li><a href="#cite">How to cite</a></li>
</ul>
</nav>
</section>
</aside>
</div>
</article>
<footer>
<div class="background"></div>
<div>
<span>© 2017-2024 <a href="https://larsgw.github.io">Lars Willighagen</a></span>
<span>Citation.js</span>
<a href="https://github.com/citation-js/site">Edit on GitHub</a>
</div>
</footer>
</body>
</html>