ampless 0.2.0-alpha.5 → 0.2.0-alpha.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.ja.md +49 -0
- package/README.md +3 -0
- package/package.json +1 -1
package/README.ja.md
ADDED
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
> English: [README.md](./README.md)
|
|
2
|
+
>
|
|
3
|
+
|
|
4
|
+
# ampless
|
|
5
|
+
|
|
6
|
+
AWS Amplify 向け CMS コアライブラリ。
|
|
7
|
+
|
|
8
|
+
> **プレリリース / アルファ版。** v1.0 まではマイナーバージョンでも破壊的変更が入る可能性があります。全文ドキュメントは [ルート README](https://github.com/heavymoons/ampless#readme) を参照してください。
|
|
9
|
+
|
|
10
|
+
## 概要
|
|
11
|
+
|
|
12
|
+
`ampless` は [ampless](https://github.com/heavymoons/ampless) CMS を支えるコアライブラリです。以下を公開しています：
|
|
13
|
+
|
|
14
|
+
- `defineConfig()` — ユーザー向け `cms.config.ts` スキーマ
|
|
15
|
+
- `defineSchema()` — コンテンツタイプ定義（カスタムコンテンツタイプシステムは v0.2 で完成予定）
|
|
16
|
+
- `Post` / `Page` / `Media` / `AuthContext` 共有型
|
|
17
|
+
- プラグインコントラクト（`definePlugin`、`AmplessPlugin`、フック、`PluginRuntimeContext`、イベント型、`escapeXml` / `formatPublicAssetUrl`）
|
|
18
|
+
- DI スタイルの `setPostsProvider()` — テンプレートの Amplify データラッパーが注入します。未設定の場合は API がダミーの投稿を返すため、AWS を接続する前にプロトタイプを作成できます。
|
|
19
|
+
|
|
20
|
+
通常は `ampless` に直接依存する必要はありません — `create-ampless` のブログテンプレートや `@ampless/plugin-*` が依存パッケージとして取り込みます。独自のプラグインやテーマを作成する場合にのみ直接インストールしてください。
|
|
21
|
+
|
|
22
|
+
## インストール
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
npm install ampless@alpha
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## 使い方
|
|
29
|
+
|
|
30
|
+
```ts
|
|
31
|
+
import { defineConfig } from 'ampless'
|
|
32
|
+
|
|
33
|
+
export default defineConfig({
|
|
34
|
+
site: {
|
|
35
|
+
name: 'My Blog',
|
|
36
|
+
url: 'https://example.com',
|
|
37
|
+
},
|
|
38
|
+
plugins: [],
|
|
39
|
+
})
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
## 動作要件
|
|
43
|
+
|
|
44
|
+
- Node.js >= 20
|
|
45
|
+
- AWS Amplify Gen 2
|
|
46
|
+
|
|
47
|
+
## ライセンス
|
|
48
|
+
|
|
49
|
+
[MIT](../../LICENSE)
|
package/README.md
CHANGED