Skip to content

Commit cc8b1c8

Browse files
committed
chore: update docs
1 parent ae64c0b commit cc8b1c8

File tree

5 files changed

+19
-7
lines changed

5 files changed

+19
-7
lines changed

docs/1.guide/1.index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
icon: ph:book-open-duotone
3+
---
4+
15
# Getting Started
26

37
Automd scans for the annotation comments within the markdown document and updates their contents using built-in generators.

docs/1.guide/2.config.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
icon: ri:settings-3-line
3+
---
4+
15
# Configuration
26

37
You can specify custom configuration using `.automdrc` or `automd.config` (with `.ts`, `.mjs`, `.json`, ... powered by [unjs/c12](https://c12.unjs.io))

docs/1.guide/3.api.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1+
---
2+
icon: eos-icons:api-outlined
3+
---
4+
15
# Programmatic API
26

3-
> [!NOTE]
4-
> This feature is not stable yet!
7+
> [!IMPORTANT]
8+
> Programmatic API is not stable!
59
610
```js
7-
// ESM
8-
import {} from "automd";
9-
10-
// CommonJS
11-
const {} = require("automd");
11+
import { automd, transform } from "automd";
1212
```

docs/1.guide/4.generators.md renamed to docs/2.generators/1.index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
icon: fluent-mdl2:generate
3+
---
4+
15
# Generators
26

37
Automd uses an extendable system of generators that are responsible to maintain each `<-- automd:name -->` section.

docs/bun.lockb

352 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)