Skip to content

Commit eed32c5

Browse files
PostCSS Preset Env Website (#232)
* Creating basic structure * Landing page * extra workspace (#237) * Finish the landing page * Playground and reusing * Updating dependencies * Moving to simpler file * Starting features * Fixing tests * Creating features * Finishing site * Finishing it * Trying to fix CSS * Update sites/postcss-preset-env/src/styles/_global.css Co-authored-by: Romain Menke <11521496+romainmenke@users.noreply.github.com> * Fixing CSS * Adding deploy action * Linting * Updating docs * Labeler * postcss-preset-env : website - a11y (#247) * postcss-preset-env : website - a11y * fix labeler * more fixes * more fixes Co-authored-by: Romain Menke <11521496+romainmenke@users.noreply.github.com>
1 parent 7e48004 commit eed32c5

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+16651
-2067
lines changed

.github/labeler.yml

+2
Original file line numberDiff line numberDiff line change
@@ -167,3 +167,5 @@
167167
- plugins/postcss-system-ui-font-family/**
168168
- experimental/postcss-system-ui-font-family/**
169169

170+
"sites/postcss-preset-env":
171+
- sites/postcss-preset-env/**
+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
name: Deploy PostCSS Preset Env
2+
on:
3+
workflow_dispatch:
4+
push:
5+
branches:
6+
- 'main'
7+
paths:
8+
- 'sites/postcss-preset-env/**'
9+
10+
jobs:
11+
build:
12+
name: Request Netlify Webhook
13+
runs-on: ubuntu-latest
14+
steps:
15+
- name: Curl request
16+
run: curl -X POST -d {} ${{ secrets.PRESET_ENV_DEPLOY_HOOK }}

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,4 @@ reports
44
.stryker-tmp
55
*/**/package-lock.json
66
!e2e/webpack/bundle-through/package-lock.json
7+
!sites/*/package-lock.json

CONTRIBUTING.md

+34-10
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,15 @@ Remember, a bug is a _demonstrable problem_ caused by _our_ code.
1414

1515
_If this guide itself is not working or is not clear, please report it._
1616

17+
## Project setup
18+
19+
If you do need to set the project up locally yourself, feel free to follow these
20+
instructions:
21+
22+
### System Requirements
23+
24+
- [Node.js](https://nodejs.org/) >= 16.0.0
25+
1726
## Submitting Pull Requests
1827

1928
Pull requests are the greatest contributions, so be sure they are focused in
@@ -29,14 +38,29 @@ scope and avoid unrelated commits.
2938

3039
# Assign the original repo to a remote called "upstream"
3140
git remote add upstream https://github.com/csstools/postcss-plugins.git
41+
```
42+
43+
2. Where are you contributing?
3244

33-
# Install and build the needed things to start local development
34-
# This also does an initial test of everything.
35-
# If this gives errors please open an issue so that we can look into it.
36-
npm run get-me-going
45+
* If you want to contribute to plugins, plugin-packs or the CLI, run the following command:
46+
47+
```bash
48+
# Install and build the needed things to start local development
49+
# This also does an initial test of everything.
50+
# If this gives errors please open an issue so that we can look into it.
51+
npm run get-me-going
52+
```
53+
54+
* If you want to contribute to sites, you need to run the following command:
55+
56+
```bash
57+
cd sites
58+
# Install the needed things to start local development
59+
# If this gives errors please open an issue so that we can look into it.
60+
npm run get-me-going
3761
```
3862

39-
2. Create a branch for your feature or fix:
63+
3. Create a branch for your feature or fix:
4064
```bash
4165
# Move into a new branch for your feature
4266
git checkout -b feature/thing
@@ -76,9 +100,9 @@ That’s it! Now [open a pull request] with a clear title and description.
76100

77101
## Creating a new plugin here
78102

79-
- follow the guide for submitting a pull request
80-
- run `npm run get-me-going` if you want to start local development.
81-
- run `npm run new-plugin` to create a new plugin.
103+
- Follow the guide for submitting a pull request
104+
- Run `npm run get-me-going` if you want to start local development.
105+
- Run `npm run new-plugin` to create a new plugin.
82106

83107
```bash
84108
npm run new-plugin
@@ -119,8 +143,8 @@ If you get warning about missing files, modules, packages you should do :
119143

120144
_if your issues is not mentioned here please open an issue so that we can extend the guides_
121145

122-
[already been reported]: issues
123-
[fork this project]: fork
146+
[already been reported]: https://github.com/csstools/postcss-plugins/issues
147+
[fork this project]: https://github.com/csstools/postcss-plugins/fork
124148
[live example]: https://codepen.io/pen
125149
[open a pull request]: https://help.github.com/articles/using-pull-requests/
126150
[reduced test case]: https://css-tricks.com/reduced-test-cases/

README.md

+36-1
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,51 @@
33
[<img alt="build status" src="https://github.com/csstools/postcss-plugins/workflows/test/badge.svg" height="20">][cli-url]
44
[<img alt="Discord" src="https://shields.io/badge/Discord-5865F2?logo=discord&logoColor=white">][discord]
55

6+
We are happy you're here!
7+
8+
This repository uses a monorepo architecture that contains plugins, plugin-packs and CLI tools to help you transform your CSS so every browser can understand it.
9+
10+
Our wish is that you can leverage the CSS that will become a standard with every browser!
11+
12+
## A brief look into the structure
13+
14+
This repository leverages [NPM Workspaces] to handle every package/project.
15+
616
[PostCSS Plugins] contains tools and plugins for [PostCSS Preset Env].
717

818
[PostCSS Preset Env] lets you convert modern CSS into something most browsers
919
can understand, determining the polyfills you need based on your targeted
1020
browsers or runtime environments.
1121

22+
There's also a [CLI] that allows you to quickly debug or prototype without having to configure PostCSS before you need any toolchain.
23+
24+
Under [sites] you can find websites that we publish to better display all of this information.
25+
26+
## Our current focus
27+
28+
We're trying to bring every reasonable CSS Spec into all the browsers.
29+
30+
First we keep track of new features through the [CSSDB] (see the [repo][CSSDB Repo]). Then we do our best to create a [PostCSS] plugin that can convert that new syntax/function/rules so every browser can understand it.
31+
32+
While it's not always possible we're enabling over 30 features with these plugins!
33+
34+
You can keep track of our current efforts on the [PostCSS Preset Env Project] and also read announcements on the [project's discussions][discussions].
35+
36+
## Contributing
37+
38+
Thanks for being willing to contribute! Please read our [contributing guide]!
39+
1240
[cli-img]: https://github.com/csstools/postcss-plugins/workflows/test/badge.svg
1341
[cli-url]: https://github.com/csstools/postcss-plugins/actions/workflows/test.yml?query=workflow/test
1442
[discord]: https://discord.gg/bUadyRwkJS
15-
43+
[discussions]: https://github.com/csstools/postcss-plugins/discussions
1644
[PostCSS]: https://github.com/postcss/postcss
1745
[PostCSS Plugins]: https://github.com/csstools/postcss-plugins
46+
[CLI]: https://github.com/csstools/postcss-plugins/cli/csstools-cli
47+
[sites]: https://github.com/csstools/postcss-plugins/sites
1848
[PostCSS Preset Env]: https://github.com/csstools/postcss-plugins/tree/main/plugin-packs/postcss-preset-env
49+
[NPM Workspaces]: https://docs.npmjs.com/cli/v7/using-npm/workspaces/
50+
[contributing guide]: https://github.com/csstools/postcss-plugins/CONTRIBUTING.md
51+
[CSSDB]: https://cssdb.org/
52+
[CSSDB Repo]: https://github.com/csstools/cssdb
53+
[PostCSS Preset Env Project]: https://github.com/orgs/csstools/projects/3/views/1

0 commit comments

Comments
 (0)