chore: housekeeping (#54)
* chore: remove lit & fast reference in readme * chore: remove sourcehut build automation * chore(docs): various changes
This commit is contained in:
GitHub
parent
f18acf0210
commit
9abf7fcc6b
6 changed files with 27 additions and 55 deletions
35
.build.yml
35
.build.yml
|
|
@ -1,35 +0,0 @@
|
|||
image: alpine/edge
|
||||
packages:
|
||||
- nodejs
|
||||
- npm
|
||||
- pnpm
|
||||
secrets:
|
||||
- 34883663-8684-41cb-9920-8e96345ef166
|
||||
- bbfcb6dc-7c4a-42ee-a11a-022f0339a133
|
||||
environment:
|
||||
NETLIFY_SITE_ID: bfd69adf-f754-433c-9690-63426f0d2fa0
|
||||
GH_USER: ayoayco
|
||||
REPO: wcb
|
||||
tasks:
|
||||
- push-mirror: |
|
||||
cd ~/"${REPO}"
|
||||
git config --global credential.helper store
|
||||
git push --mirror "https://github.com/${GH_USER}/${REPO}"
|
||||
- install-deps: |
|
||||
cd ~/"${REPO}"
|
||||
pnpm i --ignore-scripts
|
||||
- test: |
|
||||
cd ~/"${REPO}"
|
||||
npx vitest run
|
||||
- build: |
|
||||
cd ~/"${REPO}"
|
||||
pnpm -F docs build
|
||||
- deploy: |
|
||||
cd wcb
|
||||
{
|
||||
set +x
|
||||
. ~/.buildsecrets
|
||||
set -x
|
||||
}
|
||||
export NETLIFY_AUTH_TOKEN
|
||||
pnpm -F docs run deploy
|
||||
|
|
@ -13,8 +13,6 @@ When you extend the `WebComponent` class for your component, you only have to de
|
|||
|
||||
The result is a reactive UI on property changes.
|
||||
|
||||
There's a trade off between productivity & lightweight-ness here, and it is somewhere between [Microsoft's FASTElement](https://github.com/microsoft/fast) & [Google's LitElement](https://github.com/lit/lit/).
|
||||
|
||||
## Links
|
||||
|
||||
- [Documentation](https://webcomponent.io)
|
||||
|
|
@ -28,7 +26,7 @@ There are many ways to get in touch:
|
|||
1. Open a [GitHub issue](https://github.com/ayoayco/wcb/issues/new) or [discussion](https://github.com/ayoayco/wcb/discussions)
|
||||
1. Submit a ticket via [SourceHut todo](https://todo.sr.ht/~ayoayco/wcb)
|
||||
1. Email me: [ayo@ayco.io](mailto:ayo@ayco.io)
|
||||
1. Join Discord: [Ayo's Projects](https://discord.gg/kkvW7GYNAp)
|
||||
1. Chat on Discord: [Ayo's Projects](https://discord.gg/kkvW7GYNAp)
|
||||
|
||||
## Inspirations and thanks
|
||||
|
||||
|
|
@ -38,4 +36,4 @@ There are many ways to get in touch:
|
|||
|
||||
---
|
||||
*Just keep building.*<br>
|
||||
*A project by [Ayo Ayco](https://ayo.ayco.io)*
|
||||
*A project by [Ayo Ayco](https://ayo.ayco.io)*
|
||||
|
|
|
|||
|
|
@ -28,9 +28,7 @@ If you have some complex needs, we recommend using the `WebComponent` base class
|
|||
|
||||
## Installation
|
||||
|
||||
The library is distributed as complete ECMAScript Modules (ESM) and published on [NPM](https://ayco.io/n/web-component-base). Please
|
||||
email a ticket at [~ayoayco/wcb@todo.sr.ht](mailto:~ayoayco/wcb@todo.sr.ht) or submit via [SourceHut todo](https://todo.sr.ht/~ayoayco/wcb)
|
||||
for problems or requests regarding our distribution. You can also start a [GitHub discussion](https://github.com/ayoayco/wcb/discussions).
|
||||
The library is distributed as complete ECMAScript Modules (ESM) and published on [NPM](https://ayco.io/n/web-component-base). Please open a [GitHub issue](https://github.com/ayoayco/wcb/issues/new) or [discussion](https://github.com/ayoayco/wcb/discussions) for problems or requests regarding our distribution. You can also submit a ticket in [SourceHut](https://todo.sr.ht/~ayoayco/wcb).
|
||||
|
||||
### Import via CDN
|
||||
|
||||
|
|
|
|||
|
|
@ -1,12 +0,0 @@
|
|||
---
|
||||
title: Why use this base class?
|
||||
slug: 'why'
|
||||
---
|
||||
|
||||
Often times, when simple websites need a quick custom element, the best way is still to create one extending from `HTMLElement`. However, it can quickly reach a point where writing the code from scratch can seem confusing and hard to maintain especially when compared to other projects with more advanced setups.
|
||||
|
||||
Also, when coming from frameworks with an easy declarative coding experience (using templates), the default imperative way (e.g., creating instances of elements, manually attaching event handlers, and other DOM manipulations) is a frequent pain point we see.
|
||||
|
||||
This project aims to address these with virtually zero tooling required and thin abstractions from vanilla custom element APIs – giving you only the bare minimum code to be productive.
|
||||
|
||||
It works on current-day browsers without needing compilers, transpilers, or polyfills.
|
||||
23
docs/src/content/docs/guides/why.mdx
Normal file
23
docs/src/content/docs/guides/why.mdx
Normal file
|
|
@ -0,0 +1,23 @@
|
|||
---
|
||||
title: Why use this base class?
|
||||
slug: 'why'
|
||||
---
|
||||
|
||||
import { Aside, Badge } from '@astrojs/starlight/components';
|
||||
|
||||
Often times, when simple websites need a quick custom element, the simplest way is to create one extending from `HTMLElement`. However, it can quickly reach a point where writing the code from scratch can seem confusing and hard to maintain especially when compared to other projects with more advanced setups.
|
||||
|
||||
Also, when coming from frameworks with an easy declarative coding experience (using templates), the default imperative way (e.g., creating instances of elements, manually attaching event handlers, and other DOM manipulations) is a frequent pain point we see.
|
||||
|
||||
By taking out bigger concerns that [a metaframework](https://github.com/ayoayco/mcfly) should handle, this project aims to focus on keeping the component-level matters simple and lightweight. This allows for addressing the said problems with virtually zero tooling required and thin abstractions from vanilla custom element APIs – giving you only the bare minimum code to be productive.
|
||||
|
||||
It works on current-day browsers without needing compilers, transpilers, or polyfills.
|
||||
|
||||
<Aside type="tip">
|
||||
Have questions or suggestions? There are many ways to get in touch:
|
||||
|
||||
1. Open a [GitHub issue](https://github.com/ayoayco/wcb/issues/new) or [discussion](https://github.com/ayoayco/wcb/discussions)
|
||||
1. Submit a ticket via [SourceHut todo](https://todo.sr.ht/~ayoayco/wcb)
|
||||
1. Email me: [ayo@ayco.io](mailto:ayo@ayco.io)
|
||||
1. Chat on Discord: [Ayo's Projects](https://discord.gg/kkvW7GYNAp)
|
||||
</Aside>
|
||||
|
|
@ -10,7 +10,7 @@ hero:
|
|||
- text: Get Started
|
||||
link: /getting-started
|
||||
icon: right-arrow
|
||||
- text: Play on CodePen
|
||||
- text: Try on CodePen
|
||||
link: https://codepen.io/ayoayco-the-styleful/pen/PoVegBK?editors=1010
|
||||
icon: external
|
||||
variant: minimal
|
||||
|
|
|
|||
Loading…
Reference in a new issue