Skip to content

Commit c3675b6

Browse files
committed
readme
1 parent bdcbabd commit c3675b6

File tree

1 file changed

+28
-27
lines changed

1 file changed

+28
-27
lines changed

README.md

Lines changed: 28 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -6,50 +6,51 @@ Author interactive math equations and diagrams online using LaTeX and PSTricks
66

77
Author real LaTeX+PSTricks in React, Vue.js, or pure HTML5.
88

9+
## Quick Start
10+
911
```sh
1012
npm install latex2html5
1113
npm install latex2vue
1214
npm install latex2react
1315
```
1416

15-
[LaTeX2JS website](https://latex2js.com)
16-
17-
[Example Diagrams](https://latex2js.com/examples)
18-
19-
[Installation](https://latex2js.com/installation)
17+
## Resources
2018

21-
[Original Video](http://www.youtube.com/watch?v=QYMLMUKJyFc)
19+
- [LaTeX2JS website](https://latex2js.com)
20+
- [Example Diagrams](https://latex2js.com/examples)
21+
- [Installation Guide](https://latex2js.com/installation)
22+
- [Original Video](http://www.youtube.com/watch?v=QYMLMUKJyFc)
2223

23-
## Packages
24+
## Core Packages
2425

25-
These are the relevant packages for usage:
26+
These are the main packages for rendering LaTeX content:
2627

27-
| Package | Description | Documentation |
28-
|---------|-------------|---------------|
29-
| [latex2js](packages/latex2js) | Core LaTeX parsing and rendering engine with environment support | [README](packages/latex2js/README.md) |
30-
| [latex2html5](packages/html5) | Pure HTML5 implementation with automatic discovery and bundled JavaScript distribution | [README](packages/html5/README.md) |
31-
| [latex2react](packages/react) | React components for LaTeX rendering with interactive graphics and mathematical notation | [README](packages/react/README.md) |
32-
| [latex2vue](packages/vue) | Vue.js components for LaTeX rendering with Composition API and SSR support | [README](packages/vue/README.md) |
28+
| Package | Description |
29+
|---------|-------------|
30+
| [latex2js](packages/latex2js) | Core LaTeX parsing and rendering engine with environment support |
31+
| [latex2html5](packages/html5) | Pure HTML5 implementation with automatic discovery and bundled JavaScript distribution |
32+
| [latex2react](packages/react) | React components for LaTeX rendering with interactive graphics and mathematical notation |
33+
| [latex2vue](packages/vue) | Vue.js components for LaTeX rendering with Composition API and SSR support |
3334

34-
## MathJax Packages
35+
## MathJax Integration
3536

3637
If you just want to render equations using MathJax:
3738

38-
| Package | Description | Documentation |
39-
|---------|-------------|---------------|
40-
| [mathjaxjs](packages/mathjaxjs) | Pure HTML5 MathJax loading utilities for mathematical notation rendering | [README](packages/mathjaxjs/README.md) |
41-
| [mathjaxjs-react](packages/mathjaxjs-react) | React wrapper and provider for MathJax with modern hooks-based architecture | [README](packages/mathjaxjs-react/README.md) |
39+
| Package | Description |
40+
|---------|-------------|
41+
| [mathjaxjs](packages/mathjaxjs) | Pure HTML5 MathJax loading utilities for mathematical notation rendering |
42+
| [mathjaxjs-react](packages/mathjaxjs-react) | React wrapper and provider for MathJax with modern hooks-based architecture |
4243

43-
## Internal Utility Packages
44+
## Advanced Packages
4445

45-
Other utilties for internal usage:
46+
Internal utilities for extending functionality:
4647

47-
| Package | Description | Documentation |
48-
|---------|-------------|---------------|
49-
| [@latex2js/utils](packages/utils) | Core utilities for string processing, coordinate transformations, and SVG manipulation | [README](packages/utils/README.md) |
50-
| [@latex2js/settings](packages/settings) | Configuration management for PSTricks graphics settings and parameters | [README](packages/settings/README.md) |
51-
| [@latex2js/macros](packages/macros) | Comprehensive collection of LaTeX macro definitions for mathematical notation | [README](packages/macros/README.md) |
52-
| [@latex2js/pstricks](packages/pstricks) | PSTricks graphics engine with interactive elements and coordinate system support | [README](packages/pstricks/README.md) |
48+
| Package | Description |
49+
|---------|-------------|
50+
| [@latex2js/utils](packages/utils) | Core utilities for string processing, coordinate transformations, and SVG manipulation |
51+
| [@latex2js/settings](packages/settings) | Configuration management for PSTricks graphics settings and parameters |
52+
| [@latex2js/macros](packages/macros) | Comprehensive collection of LaTeX macro definitions for mathematical notation |
53+
| [@latex2js/pstricks](packages/pstricks) | PSTricks graphics engine with interactive elements and coordinate system support |
5354

5455
## Credits
5556

0 commit comments

Comments
 (0)