@uniweb/scholar

Academic content utilities for Uniweb: math rendering, bibliographic references, and inline citations.

Installation

``bash
npm install @uniweb/scholar


or


pnpm add @uniweb/scholar
`

Features

- Math Rendering - LaTeX equations with KaTeX (lazy-loaded)
- Bibliography - Format references in APA, MLA, Chicago, and IEEE styles
- Citations - Track inline citations with automatic bibliography generation
- BibTeX - Parse and export BibTeX format
- UI Components - Ready-to-use citation buttons, author lists, and DOI links

Quick Start

$3

`jsx
import { Math, Equation, EquationRef, EquationProvider } from '@uniweb/scholar/math'

// Inline math


The equation $E\; =\; mc^2$ shows mass-energy equivalence.

// Display (block) math

\int_0^\infty e^{-x^2} dx = \frac{\sqrt{\pi}}{2}


// Numbered equations with cross-references

E = mc^2


As shown in , energy equals mass times the speed of light squared.



`

$3

`jsx
import { CitationProvider, Citation, Bibliography } from '@uniweb/scholar/citations'

const references = [
{
id: 'smith2024',
type: 'article',
authors: [{ family: 'Smith', given: 'John' }],
title: 'A Study of Something Important',
journal: 'Journal of Studies',
year: 2024,
volume: '10',
pages: '1-15',
doi: '10.1234/example'
}
]





Recent research has shown significant progress.


According to , the findings are clear.

`

$3

`jsx
import { CitationProvider, Citation, Bibliography } from '@uniweb/scholar/citations'

const bibtex =
@article{smith2024,
author = {Smith, John and Doe, Jane},
title = {A Study of Something Important},
journal = {Journal of Studies},
year = {2024},
volume = {10},
pages = {1--15},
doi = {10.1234/example}
}




Research shows that...




`

API Reference

$3

#### $$

Renders inline or display LaTeX math.

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| children | string | - | LaTeX expression |
| display | boolean | false | Display mode (block) vs inline |
| className | string | - | CSS classes |

####

Renders a numbered equation with optional label.

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| children | string | - | LaTeX expression |
| id | string | auto | Unique ID for cross-referencing |
| label | string | - | Custom label (defaults to number) |

####

Creates a reference link to a numbered equation.

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| id | string | - | ID of equation to reference |
| format | string | 'parentheses' | 'parentheses', 'plain', or 'equation' |

####

Context provider for equation numbering. Wrap content containing equations.

$3

####

Manages citation state for a document.

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| references | Array\|string | - | Reference objects or BibTeX string |
| style | string | 'apa' | Citation style |
| children | ReactNode | - | Document content |

####

Renders an inline citation.

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| id | string | - | Reference ID to cite |
| ids | string[] | - | Multiple reference IDs |
| page | string | - | Page number(s) |
| prefix | string | - | Text before citation |
| suffix | string | - | Text after citation |
| suppressAuthor | boolean | false | Show only year |
| format | string | 'parenthetical' | 'parenthetical', 'narrative', 'numeric' |

####

Renders the list of cited references.

| Prop | Type | Default | Description |
|------|------|---------|-------------|
| title | string | 'References' | Section title |
| showTitle | boolean | true | Whether to show title |
| showAll | boolean | false | Show all refs, not just cited |

$3

#### formatReference(publication, options)

Format a reference in a specific style.

`js
import { formatReference } from '@uniweb/scholar/bibliography'

const ref = formatReference({
type: 'article',
authors: [{ family: 'Smith', given: 'John' }],
title: 'A Study',
journal: 'Journal',
year: 2024
}, { style: 'apa' })
`

#### parseBibtex(bibtex) / exportBibtex(publication)

Parse BibTeX to objects or export objects to BibTeX.

`js
import { parseBibtex, exportBibtex } from '@uniweb/scholar/bibliography'

const refs = parseBibtex(bibtexString)
const bibtex = exportBibtex(publication)
`

$3

####

Dropdown button to copy citations in various formats.

`jsx
import { CiteButton } from '@uniweb/scholar/components'

publication={pub}
styles={['apa', 'mla', 'bibtex']}
/>
`

####

Display copyable BibTeX entry.

`jsx
import { BibtexBlock } from '@uniweb/scholar/components'


`

####

Formatted author names with optional ORCID links.

`jsx
import { AuthorList } from '@uniweb/scholar/components'

authors={[
{ family: 'Smith', given: 'John', orcid: '0000-0001-2345-6789' }
]}
style="apa"
/>
`

####

DOI with automatic link.

`jsx
import { DoiLink } from '@uniweb/scholar/components'


`

Citation Styles

| Style | Description |
|-------|-------------|
| apa | APA 7th Edition |
| mla | MLA 9th Edition |
| chicago | Chicago Author-Date |
| ieee | IEEE (numeric) |

Reference Object Structure

`js
{
id: 'smith2024', // Citation key
type: 'article', // article, book, inproceedings, etc.
authors: [ // Array of author objects
{ family: 'Smith', given: 'John', orcid: '...' }
],
title: 'Article Title',
journal: 'Journal Name', // For articles
bookTitle: 'Book Title', // For chapters
year: 2024,
volume: '10',
issue: '2',
pages: '1-15',
publisher: 'Publisher',
doi: '10.1234/example',
url: 'https://...',
abstract: '...',
keywords: ['keyword1', 'keyword2']
}
``

Bundle Size

The package uses lazy loading to minimize initial bundle size:

| Module | Size |
|--------|------|
| bibliography (formatters, parsers) | ~15KB |
| math (without KaTeX) | ~5KB |
| KaTeX (lazy-loaded on first use) | ~90KB |
| citations | ~10KB |
| components | ~8KB |

KaTeX CSS is automatically injected when math rendering is first used.

License

Apache-2.0