@awesome.me/buildawesome 0.0.1 → 4.0.0-alpha.10
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 +55 -2
- package/cmd.js +6 -0
- package/package.json +31 -6
- package/src/Core.js +2 -0
- package/src/UserConfig.js +4 -0
- package/src/Util/Git.js +4 -0
- package/types/UserConfig.d.ts +1 -0
- package/types/Util/Git.d.ts +1 -0
- package/index.js +0 -1
package/README.md
CHANGED
|
@@ -1,3 +1,56 @@
|
|
|
1
|
-
|
|
1
|
+
<p align="center"><img src="./docs/ba-11ty-logo.png" width="200" height="200" alt="Build Awesome (balloon) and 11ty Logo"></p>
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
# Build Awesome (Eleventy) 🕚⚡️🎈🐀
|
|
4
|
+
|
|
5
|
+
A simpler static site generator. An alternative to Jekyll. Written in JavaScript. Transforms a directory of templates (of varying types) into HTML.
|
|
6
|
+
|
|
7
|
+
Works with HTML, Markdown, JavaScript, Liquid, Nunjucks, with addons for WebC, Sass, Vue, Svelte, TypeScript, JSX, and many others!
|
|
8
|
+
|
|
9
|
+
## ➡ [Documentation](https://www.11ty.dev/docs/)
|
|
10
|
+
|
|
11
|
+
- Star [this repo on GitHub](https://github.com/11ty/buildawesome/)!
|
|
12
|
+
- Follow us [on Mastodon `@11ty@neighborhood.11ty.dev`](https://neighborhood.11ty.dev/@11ty)
|
|
13
|
+
- Follow us [on Bluesky `@11ty.dev`](https://bsky.app/profile/11ty.dev)
|
|
14
|
+
- Install [from npm](https://www.npmjs.com/org/11ty)
|
|
15
|
+
- Follow [on GitHub](https://github.com/11ty)
|
|
16
|
+
- Watch us [on YouTube](https://www.youtube.com/c/EleventyVideo)
|
|
17
|
+
- Chat on [Discord](https://www.11ty.dev/blog/discord/)
|
|
18
|
+
- Latest: [](https://www.npmjs.com/package/@11ty/eleventy)
|
|
19
|
+
|
|
20
|
+
## Installation
|
|
21
|
+
|
|
22
|
+
```
|
|
23
|
+
npm install @awesome.me/buildawesome --save-dev
|
|
24
|
+
|
|
25
|
+
# Backwards compatible here too:
|
|
26
|
+
npm install @11ty/eleventy --save-dev
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
Read our [Getting Started guide](https://www.11ty.dev/docs/getting-started/).
|
|
30
|
+
|
|
31
|
+
## Tests
|
|
32
|
+
|
|
33
|
+
```
|
|
34
|
+
npm test
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
We have a few test suites, for various reasons:
|
|
38
|
+
|
|
39
|
+
- [ava JavaScript test runner](https://github.com/avajs/ava) ([assertions docs](https://github.com/avajs/ava/blob/main/docs/03-assertions.md)) (primary test suite in `test/`)
|
|
40
|
+
- [Node.js Test runner](https://nodejs.org/api/test.html) (secondary test suite in `test_node/`)
|
|
41
|
+
- [Vitest (in Browser Mode)](https://vitest.dev/guide/browser/) (browser tests in `packages/browser/test/`)
|
|
42
|
+
- [Benchmark for Performance Regressions](https://github.com/11ty/buildbenchmark)
|
|
43
|
+
|
|
44
|
+
These run in various environments:
|
|
45
|
+
|
|
46
|
+
- [Continuous Integration on GitHub Actions](https://github.com/11ty/buildawesome/actions/workflows/ci.yml)
|
|
47
|
+
- [Code Coverage Statistics](https://github.com/11ty/buildawesome/blob/master/docs/coverage.md)
|
|
48
|
+
|
|
49
|
+
## Community Roadmap
|
|
50
|
+
|
|
51
|
+
- [Top Feature Requests](https://github.com/11ty/buildawesome/discussions/categories/enhancement-queue?discussions_q=is%3Aopen+category%3A%22Enhancement+Queue%22+sort%3Atop) (Vote for your favorites!)
|
|
52
|
+
- [Top Bugs 😱](https://github.com/11ty/buildawesome/issues?q=is%3Aissue+is%3Aopen+label%3Abug+sort%3Areactions) (Add your own votes using the 👍 reaction)
|
|
53
|
+
|
|
54
|
+
## Plugins
|
|
55
|
+
|
|
56
|
+
See the [official docs on plugins](https://www.11ty.dev/docs/plugins/).
|
package/cmd.js
ADDED
package/package.json
CHANGED
|
@@ -1,13 +1,38 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@awesome.me/buildawesome",
|
|
3
3
|
"description": "A simpler way to build awesome web sites.",
|
|
4
|
-
"version": "0.0.
|
|
4
|
+
"version": "4.0.0-alpha.10",
|
|
5
5
|
"publishConfig": {
|
|
6
|
-
"access": "public"
|
|
6
|
+
"access": "public",
|
|
7
|
+
"provenance": true
|
|
7
8
|
},
|
|
8
|
-
"main": "index.js",
|
|
9
9
|
"type": "module",
|
|
10
|
+
"exports": {
|
|
11
|
+
".": "./src/Core.js",
|
|
12
|
+
"./UserConfig": {
|
|
13
|
+
"types": "./types/UserConfig.d.ts"
|
|
14
|
+
},
|
|
15
|
+
"./utils/git": "./src/Util/Git.js"
|
|
16
|
+
},
|
|
17
|
+
"scripts": {
|
|
18
|
+
"test": "",
|
|
19
|
+
"typescript": "tsc"
|
|
20
|
+
},
|
|
21
|
+
"bin": {
|
|
22
|
+
"buildawesome": "cmd.js"
|
|
23
|
+
},
|
|
10
24
|
"license": "MIT",
|
|
11
|
-
"author": "Zach Leatherman
|
|
12
|
-
"
|
|
13
|
-
|
|
25
|
+
"author": "Zach Leatherman (https://zachleat.com/)",
|
|
26
|
+
"repository": {
|
|
27
|
+
"type": "git",
|
|
28
|
+
"url": "git://github.com/11ty/buildawesome.git"
|
|
29
|
+
},
|
|
30
|
+
"bugs": "https://github.com/11ty/buildawesome/issues",
|
|
31
|
+
"homepage": "https://build.awesome.me/",
|
|
32
|
+
"dependencies": {
|
|
33
|
+
"@11ty/eleventy": "4.0.0-alpha.10"
|
|
34
|
+
},
|
|
35
|
+
"devDependencies": {
|
|
36
|
+
"typescript": "^6.0.3"
|
|
37
|
+
}
|
|
38
|
+
}
|
package/src/Core.js
ADDED
package/src/Util/Git.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { default } from "@11ty/eleventy/UserConfig";
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "@11ty/eleventy/utils/git";
|
package/index.js
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
throw new Error("This is the empty package for @awesome.me/buildawesome. Please upgrade to a newer non-empty version.");
|