Skip to content

Commit 0530671

Browse files
committed
docs: rename LICENSE.md to LICENSE and update documentation
- Renamed LICENSE.md to LICENSE for GitHub auto-detection - Updated all references in docs and README - Enhanced landing page with badges, v0.4.0 features, and use cases - Added configuration examples and improved content structure Authored by: Aaron Lippold<lippold@gmail.com>
1 parent 74642fa commit 0530671

File tree

3 files changed

+63
-12
lines changed

3 files changed

+63
-12
lines changed

LICENSE.md renamed to LICENSE

File renamed without changes.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ pnpm lint
150150

151151
## License
152152

153-
[Apache-2.0](./LICENSE.md) - MITRE Corporation
153+
[Apache-2.0](./LICENSE) - MITRE Corporation
154154

155155
<!-- Badges -->
156156
[npm-version-src]: https://img.shields.io/npm/v/@mitre/nuxt-smartscript/latest.svg?style=flat&colorA=020420&colorB=00DC82

docs/index.md

Lines changed: 62 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ layout: home
44
hero:
55
name: Nuxt SmartScript
66
text: Automatic Typography Transformations
7-
tagline: Smart, accessible typography enhancements for your Nuxt applications
7+
tagline: Smart, accessible typography enhancements for your Nuxt applications with full SSR/SSG support
88
actions:
99
- theme: brand
1010
text: Get Started
@@ -26,21 +26,38 @@ features:
2626
- icon: 📐
2727
title: Math Notation
2828
details: Supports x^2 superscripts and x_1 subscripts for mathematical expressions
29+
- icon: 🚀
30+
title: Full SSR/SSG Support
31+
details: Works seamlessly with server-side rendering and static generation for optimal SEO
32+
- icon: 🎯
33+
title: Smart Selectors
34+
details: Process 30+ HTML elements including headings, paragraphs, lists, tables, and more
2935
- icon:
30-
title: Performance First
31-
details: Optimized with debouncing, batching, and lazy loading for smooth user experience
36+
title: Performance Optimized
37+
details: Debouncing, batching, and caching for smooth performance even with large documents
3238
- icon:
33-
title: Fully Accessible
34-
details: ARIA labels and semantic HTML ensure screen reader compatibility
35-
- icon: 🚀
36-
title: SSR/SSG Support
37-
details: Server-side rendering and static generation for SEO-friendly content (v0.4.0)
39+
title: Accessibility First
40+
details: ARIA labels and semantic HTML ensure full screen reader compatibility
3841
---
3942

4043
## What is Nuxt SmartScript?
4144

45+
<p>
46+
<a href="https://www.npmjs.com/package/@mitre/nuxt-smartscript"><img src="https://img.shields.io/npm/v/@mitre/nuxt-smartscript?style=flat&colorA=18181B&colorB=28CF8D" alt="Version"></a>&nbsp;
47+
<a href="https://www.npmjs.com/package/@mitre/nuxt-smartscript"><img src="https://img.shields.io/npm/dm/@mitre/nuxt-smartscript?style=flat&colorA=18181B&colorB=28CF8D" alt="Downloads"></a>&nbsp;
48+
<a href="https://github.com/mitre/nuxt-smartscript/blob/main/LICENSE"><img src="https://img.shields.io/github/license/mitre/nuxt-smartscript?style=flat&colorA=18181B&colorB=28CF8D" alt="License"></a>
49+
</p>
50+
4251
Nuxt SmartScript is a powerful Nuxt module that automatically transforms typography patterns in your content to enhance readability and visual appeal. It works seamlessly with your existing Nuxt application, requiring minimal configuration.
4352

53+
## 🎉 What's New in v0.4.0
54+
55+
- **Full SSR/SSG Support** - Server-side rendering and static generation now work perfectly
56+
- **30+ Element Support** - Process headings, paragraphs, lists, tables, spans, links, and more
57+
- **Improved Performance** - Better caching and pattern matching
58+
- **Bug Fixes** - Fixed navigation issues and configuration handling
59+
- **Better TypeScript** - Improved type definitions and module builder integration
60+
4461
## Why SmartScript?
4562

4663
### 🎯 Problem
@@ -65,23 +82,57 @@ E=mc^2 is Einstein's famous equation.
6582
- H<sub>2</sub>O and CO<sub>2</sub> are common molecules.
6683
- E=mc<sup>2</sup> is Einstein's famous equation.
6784

85+
## Perfect For
86+
87+
- 📚 **Documentation Sites** - Technical docs with formulas and trademark symbols
88+
- 🏢 **Corporate Websites** - Professional typography for brand names and legal marks
89+
- 🔬 **Scientific Content** - Chemical formulas and mathematical expressions
90+
- 📰 **Publishing Platforms** - Articles with ordinal numbers and special symbols
91+
- 📖 **Educational Materials** - Math and science content with proper notation
92+
6893
## Installation
6994

7095
Install the module to your Nuxt application with one command:
7196

72-
```bash
97+
::: code-group
98+
```bash [npm]
7399
npm install @mitre/nuxt-smartscript
74100
```
101+
```bash [pnpm]
102+
pnpm add @mitre/nuxt-smartscript
103+
```
104+
```bash [yarn]
105+
yarn add @mitre/nuxt-smartscript
106+
```
107+
:::
75108

76109
Add it to your `nuxt.config.ts`:
77110

78111
```typescript
79112
export default defineNuxtConfig({
80-
modules: ['@mitre/nuxt-smartscript']
113+
modules: ['@mitre/nuxt-smartscript'],
114+
115+
// Optional: customize the behavior
116+
smartscript: {
117+
// Enable/disable specific transformations
118+
transformations: {
119+
trademark: true, // (TM) → ™
120+
registered: true, // (R) → ®
121+
copyright: true, // (C) → ©
122+
ordinals: true, // 1st → 1ˢᵗ
123+
chemicals: true, // H2O → H₂O
124+
mathSuper: true, // x^2 → x²
125+
mathSub: true, // x_1 → x₁
126+
},
127+
128+
// Full SSR/SSG support
129+
ssr: true,
130+
client: true,
131+
}
81132
})
82133
```
83134

84-
That's it! SmartScript will automatically enhance your typography.
135+
That's it! SmartScript will automatically enhance your typography across 30+ HTML elements.
85136

86137
## License
87138

0 commit comments

Comments
 (0)