create-riebeckite 0.0.16 → 0.0.18
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.md +7 -7
- package/README_ja.md +2 -2
- package/dist/src/arguments.d.ts +3 -5
- package/dist/src/index.js +3161 -37
- package/dist/src/interactive.d.ts +8 -9
- package/dist/src/scaffold/content-pages.d.ts +16 -0
- package/dist/src/scaffold/deployment.d.ts +7 -0
- package/dist/src/scaffold/index.d.ts +7 -0
- package/dist/src/scaffold/index.js +3134 -0
- package/dist/src/scaffold/next-steps.d.ts +7 -0
- package/dist/src/scaffold/options.d.ts +43 -0
- package/dist/src/scaffold/presets.d.ts +102 -0
- package/dist/src/scaffold/template-loader.d.ts +4 -0
- package/dist/src/scaffold/templates.d.ts +53 -0
- package/dist/src/scaffold/version.d.ts +1 -0
- package/dist/src/scaffold/wrangler-defaults.d.ts +46 -0
- package/package.json +16 -5
- package/templates/scaffold/base/app/client.ts +14 -0
- package/templates/scaffold/base/app/config.ts +18 -0
- package/templates/scaffold/base/app/constants/paths.ts +10 -0
- package/templates/scaffold/base/app/content.ts +12 -0
- package/templates/scaffold/base/app/global.d.ts +15 -0
- package/templates/scaffold/base/app/server.ts +13 -0
- package/templates/scaffold/base/public/favicon.ico +0 -0
- package/templates/scaffold/base/public/riebeckite-logo.png +0 -0
- package/templates/scaffold/base/tsconfig.json +30 -0
- package/templates/scaffold/base/vite.config.ts +34 -0
- package/templates/scaffold/biome.json +6 -0
- package/templates/scaffold/deployment/github-actions/content-checkout.yml +6 -0
- package/templates/scaffold/deployment/github-actions/deploy.yml +54 -0
- package/templates/scaffold/deployment/github-actions/notify-site.yml +31 -0
- package/templates/scaffold/presets/empty/app/routes/_renderer.tsx +21 -0
- package/templates/scaffold/presets/empty/app/routes/index.tsx +11 -0
- package/templates/scaffold/presets/empty/app/style.css +17 -0
- package/templates/scaffold/presets/minimal/app/components/article.tsx +66 -0
- package/templates/scaffold/presets/minimal/app/routes/[slug{.+}].tsx +48 -0
- package/templates/scaffold/presets/minimal/app/routes/_renderer.tsx +59 -0
- package/templates/scaffold/presets/minimal/app/routes/index.tsx +29 -0
- package/templates/scaffold/presets/minimal/app/style.css +84 -0
- package/templates/scaffold/presets/minimal/content/index.en.md +12 -0
- package/templates/scaffold/presets/showcase/app/components/article.tsx +66 -0
- package/templates/scaffold/presets/showcase/app/components/site-header.tsx +113 -0
- package/templates/scaffold/presets/showcase/app/routes/[slug{.+}].tsx +52 -0
- package/templates/scaffold/presets/showcase/app/routes/_renderer.tsx +69 -0
- package/templates/scaffold/presets/showcase/app/routes/index.tsx +39 -0
- package/templates/scaffold/presets/showcase/app/style.css +227 -0
- package/templates/scaffold/presets/showcase/content/attachments/project-brief.pdf +5 -0
- package/templates/scaffold/presets/showcase/content/demo/planning.md +16 -0
- package/templates/scaffold/presets/showcase/content/demo/writing.md +15 -0
- package/templates/scaffold/presets/showcase/content/drawings/Architecture.excalidraw +1 -0
- package/templates/scaffold/presets/showcase/content/drawings/site.canvas +1 -0
- package/templates/scaffold/presets/showcase/content/guide.en.md +46 -0
- package/templates/scaffold/presets/showcase/content/images/demo.svg +1 -0
- package/templates/scaffold/presets/showcase/content/index.de.md +17 -0
- package/templates/scaffold/presets/showcase/content/index.en.md +17 -0
- package/templates/scaffold/presets/showcase/content/index.es.md +17 -0
- package/templates/scaffold/presets/showcase/content/index.fr.md +17 -0
- package/templates/scaffold/presets/showcase/content/index.ja.md +17 -0
- package/templates/scaffold/presets/showcase/content/index.ko.md +17 -0
- package/templates/scaffold/presets/showcase/content/index.zh-CN.md +17 -0
- package/templates/scaffold/presets/starter/app/components/article.tsx +66 -0
- package/templates/scaffold/presets/starter/app/components/site-header.tsx +113 -0
- package/templates/scaffold/presets/starter/app/routes/[slug{.+}].tsx +52 -0
- package/templates/scaffold/presets/starter/app/routes/_renderer.tsx +69 -0
- package/templates/scaffold/presets/starter/app/routes/index.tsx +37 -0
- package/templates/scaffold/presets/starter/app/style.css +227 -0
- package/templates/scaffold/presets/starter/content/guide.en.md +60 -0
- package/templates/scaffold/presets/starter/content/index.de.md +19 -0
- package/templates/scaffold/presets/starter/content/index.en.md +19 -0
- package/templates/scaffold/presets/starter/content/index.es.md +19 -0
- package/templates/scaffold/presets/starter/content/index.fr.md +19 -0
- package/templates/scaffold/presets/starter/content/index.ja.md +19 -0
- package/templates/scaffold/presets/starter/content/index.ko.md +19 -0
- package/templates/scaffold/presets/starter/content/index.zh-CN.md +19 -0
- package/templates/scaffold/presets/starter/content/notes/planning.md +16 -0
- package/templates/scaffold/presets/starter/content/notes/writing.md +15 -0
package/README.md
CHANGED
|
@@ -35,9 +35,9 @@ The prompts ask, in order:
|
|
|
35
35
|
|
|
36
36
|
`Separate GitHub repository` also asks for the content and site repositories,
|
|
37
37
|
and GitHub Actions deployment is then configured for you. That setup is covered
|
|
38
|
-
in the [content repository guide](../../docs/
|
|
38
|
+
in the [content repository guide](../../docs/docs/guides/content-repositories.en.md).
|
|
39
39
|
Deployment can be added later, described in
|
|
40
|
-
[Deployment](../../docs/
|
|
40
|
+
[Deployment](../../docs/docs/getting-started/deployment.en.md).
|
|
41
41
|
|
|
42
42
|
## Options
|
|
43
43
|
|
|
@@ -71,7 +71,7 @@ npx create-riebeckite my-site --github-actions \
|
|
|
71
71
|
Set `content.directory` to `"content"`, add the documented repository secrets,
|
|
72
72
|
then copy `github/notify-site.yml` into the content repository as
|
|
73
73
|
`.github/workflows/notify-site.yml`. See the [separate-content deployment
|
|
74
|
-
guide](
|
|
74
|
+
guide](https://github.com/Rerurate514/riebeckite/blob/main/docs/docs/guides/deployment/separate-content-repository.en.md).
|
|
75
75
|
|
|
76
76
|
`--content-repository` automatically configures the external checkout, the
|
|
77
77
|
`content-updated` repository-dispatch receiver, and `github/notify-site.yml`.
|
|
@@ -101,15 +101,15 @@ Each preset has a one-line description, shown by `--list-presets`:
|
|
|
101
101
|
- `showcase` — The complete plugin catalog with rendered examples, local fixtures, and reference pages.
|
|
102
102
|
- `empty` — A blank application shell: no plugins, theme, content, or components.
|
|
103
103
|
|
|
104
|
-
Presets are defined in
|
|
105
|
-
tooling:
|
|
104
|
+
Presets are defined in `create-riebeckite/scaffold` and can be imported into
|
|
105
|
+
your own tooling:
|
|
106
106
|
|
|
107
107
|
```ts
|
|
108
|
-
import { scaffoldRiebeckiteSite
|
|
108
|
+
import { scaffoldRiebeckiteSite } from "create-riebeckite/scaffold";
|
|
109
109
|
|
|
110
110
|
await scaffoldRiebeckiteSite({
|
|
111
111
|
targetDirectory: "./my-site",
|
|
112
|
-
preset: showcase,
|
|
112
|
+
preset: "showcase",
|
|
113
113
|
});
|
|
114
114
|
```
|
|
115
115
|
|
package/README_ja.md
CHANGED
|
@@ -34,7 +34,7 @@ npm exec riebeckite build
|
|
|
34
34
|
| Content source | `This project`、`Separate GitHub repository` | 最初は `This project` |
|
|
35
35
|
| デプロイ設定 | `GitHub Actions + Cloudflare Workers`、`Not now` | 手元で試すなら `Not now` |
|
|
36
36
|
|
|
37
|
-
`Separate GitHub repository` を選ぶと content と site のリポジトリ名も入力し、GitHub Actions のデプロイ設定が自動で構成されます。この構成は[content repository ガイド](../../docs/
|
|
37
|
+
`Separate GitHub repository` を選ぶと content と site のリポジトリ名も入力し、GitHub Actions のデプロイ設定が自動で構成されます。この構成は[content repository ガイド](../../docs/docs/guides/content-repositories.md)に、デプロイの追加方法は [Deployment](../../docs/docs/getting-started/deployment.md) にあります。
|
|
38
38
|
|
|
39
39
|
## オプション
|
|
40
40
|
|
|
@@ -68,7 +68,7 @@ npx create-riebeckite my-site --github-actions \
|
|
|
68
68
|
`content.directory` は `"content"` にし、必要な repository Secret を登録した後、
|
|
69
69
|
`github/notify-site.yml` を記事リポジトリの
|
|
70
70
|
`.github/workflows/notify-site.yml` にコピーします。詳細は[別記事リポジトリの
|
|
71
|
-
デプロイガイド](
|
|
71
|
+
デプロイガイド](https://github.com/Rerurate514/riebeckite/blob/main/docs/docs/guides/deployment/separate-content-repository.md)を参照してください。
|
|
72
72
|
|
|
73
73
|
`--content-repository` を指定すると、外部 content の checkout、
|
|
74
74
|
`content-updated` の repository dispatch receiver、`github/notify-site.yml` がまとめて構成されます。以前の通知用オプションは廃止しました。
|
package/dist/src/arguments.d.ts
CHANGED
|
@@ -1,13 +1,11 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import type { ScaffoldDeployment } from "./scaffold/options.js";
|
|
2
|
+
import { type ScaffoldPresetName } from "./scaffold/presets.js";
|
|
2
3
|
export type CreateRiebeckiteOptions = {
|
|
3
4
|
readonly directory: string;
|
|
4
5
|
readonly force: boolean;
|
|
5
6
|
readonly preset: ScaffoldPresetName;
|
|
6
7
|
readonly listPresets: boolean;
|
|
7
|
-
readonly
|
|
8
|
-
readonly cloudflareWorkers: boolean;
|
|
9
|
-
readonly contentRepository?: string;
|
|
10
|
-
readonly siteRepository?: string;
|
|
8
|
+
readonly deployment: ScaffoldDeployment;
|
|
11
9
|
};
|
|
12
10
|
export declare function parseArguments(arguments_: readonly string[]): CreateRiebeckiteOptions;
|
|
13
11
|
export declare function printPresets(): void;
|