Skip to content

Commit 4c1f87a

Browse files
committed
Update docs
1 parent aee88d1 commit 4c1f87a

File tree

5 files changed

+22
-12
lines changed

5 files changed

+22
-12
lines changed

docs/index.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ nav_order: 1
1010

1111
**proper-tags** is an evolved version of the widely-used CommonJS package **common-tags**. It has been updated with the following considerations for modern JavaScript environments:
1212

13-
* 🌟 Extendable: proper-tags comes with built-in tools for creating custom tags.
14-
* 📦 ESM Code Base: With support for ESM/ECMAScript Modules, it ensures native compatibility with modern development tools.
15-
* 🦕 Deno Compatibility: Designed specifically to function seamlessly with the Deno runtime.
16-
* 📝 TypeScript Definitions: Integrated TypeScript typings make development in TypeScript a breeze.
17-
* 🔄 API Consistency: Its interface aligns with common-tags, ensuring compatibility with existing frameworks and guides.
13+
* 🌟 **Extendable:** Comes with built-in tools for creating custom tags.
14+
* 📦 **ESM Code Base:** Ensures native compatibility with modern development tools.
15+
* 🦕 **Deno Compatibility:** Designed specifically to function seamlessly with the Deno runtime.
16+
* 📝 **TypeScript Definitions:** Integrated TypeScript typings make development in TypeScript a breeze.
17+
* 🔄 **API Consistency:** The interface aligns with common-tags, ensuring compatibility with existing frameworks and guides.
1818

1919
## Sample Usage
2020

@@ -27,3 +27,4 @@ html`
2727
</div>
2828
```
2929

30+
For further details, check out the [Installation](https://proper-tags.56k.guru/installation.html) and [Usage](https://proper-tags.56k.guru/usage/) sections.

docs/usage/advanced.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@ nav_order: 3
99

1010
---
1111

12+
## Table of contents
13+
14+
1. Table of contents
15+
{:toc}
16+
1217
### Tail Processing
1318

1419
It's possible to pass the output of a tagged template to another template tag in pure ES2015+:

docs/usage/index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,7 @@ Like all modules, `proper-tags` begins with an `import`. In fact, `proper-tags`
1717
import { stripIndent } from 'proper-tags'
1818
```
1919

20-
1. TOC
20+
## Table of contents
21+
22+
1. Table of contents
2123
{:toc}

docs/usage/tags.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@ nav_order: 2
1111

1212
`proper-tags` exports a bunch of wonderful pre-cooked template tags for your eager consumption. They are as follows:
1313

14-
1. TOC
14+
## Table of contents
15+
16+
1. Table of contents
1517
{:toc}
1618

1719
#### `html`

readme.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@
55

66
**proper-tags** is an evolved version of the widely-used CommonJS package **common-tags**. It has been updated with the following considerations for modern JavaScript environments:
77

8-
* 🌟 Extendable: proper-tags comes with built-in tools for creating custom tags.
9-
* 📦 ESM Code Base: With support for ESM/ECMAScript Modules, it ensures native compatibility with modern development tools.
10-
* 🦕 Deno Compatibility: Designed specifically to function seamlessly with the Deno runtime.
11-
* 📝 TypeScript Definitions: Integrated TypeScript typings make development in TypeScript a breeze.
12-
* 🔄 API Consistency: Its interface aligns with common-tags, ensuring compatibility with existing frameworks and guides.
8+
* 🌟 **Extendable:** Comes with built-in tools for creating custom tags.
9+
* 📦 **ESM Code Base:** Ensures native compatibility with modern development tools.
10+
* 🦕 **Deno Compatibility:** Designed specifically to function seamlessly with the Deno runtime.
11+
* 📝 **TypeScript Definitions:** Integrated TypeScript typings make development in TypeScript a breeze.
12+
* 🔄 **API Consistency:** The interface aligns with common-tags, ensuring compatibility with existing frameworks and guides.
1313

1414
Below is a quick guide, check out the full documentation at [https://proper-tags.56k.guru](https://proper-tags.56k.guru).
1515

0 commit comments

Comments
 (0)