Skip to content
This repository was archived by the owner on Dec 28, 2022. It is now read-only.

Commit 738609c

Browse files
author
Jiří Třečák
committed
Initial commit - readme, licence, basic structure, configured exporter setting, icons
0 parents  commit 738609c

File tree

10 files changed

+191
-0
lines changed

10 files changed

+191
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**Expected behavior**
14+
A clear and concise description of what you expected to happen.
15+
16+
**Screenshots**
17+
If applicable, add screenshots to help explain your problem.
18+
19+
**Additional context**
20+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

‎LICENSE.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
MIT License
2+
3+
Copyright (c) 2021-present Supernova and other contributors
4+
5+
Permission is hereby granted, free of charge, to any person obtaining
6+
a copy of this software and associated documentation files (the
7+
"Software"), to deal in the Software without restriction, including
8+
without limitation the rights to use, copy, modify, merge, publish,
9+
distribute, sublicense, and/or sell copies of the Software, and to
10+
permit persons to whom the Software is furnished to do so, subject to
11+
the following conditions:
12+
13+
The above copyright notice and this permission notice shall be
14+
included in all copies or substantial portions of the Software.
15+
16+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

‎README.md

+98
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
<img src="./readme-icon.png" alt="Supernova Logo" style="max-width:100%;">
2+
3+
4+
[Supernova](https://supernova.io) is a design system platform that allows you to seamlessly translate your design system data to production-ready code. Supernova works with any platform or tech stack, is used by many developers and organizations around the world, and can help you save time by replacing manual and repetitive tasks that all developers hate. To learn everything Supernova, please check out our [developer documentation](https://developers.supernova.io/).
5+
6+
7+
# CSS Exporter
8+
9+
10+
The CSS allows you to **produce a CSS definitions** in such a way that it can be immediately used in your production codebase to style all your visual elements. Specifically, this exporter is capable of exporting the previews of:
11+
12+
- [x] Color definitions
13+
- [x] Text Styles
14+
- [x] Gradients
15+
- [x] Shadows
16+
- [x] Borders
17+
- [x] Radii
18+
- [x] Measures
19+
20+
You can generate all production ready-code either manually using Supernova's [VS Code extension](https://marketplace.visualstudio.com/items?itemName=SupernovaIO.pulsar-vsc-extension), or automate your code delivery pipeline using Supernova [Design Continuous Delivery](https://supernova.io/automated-code-delivery).
21+
22+
23+
## Example Usage
24+
25+
Once you have run the exporter against your design system, you can start using the code in your codebase right away. Here are a few examples of how you can use the output of the CSS exporter:
26+
27+
### [Example 1]
28+
29+
[Todo description]
30+
31+
```
32+
[Code]
33+
```
34+
35+
36+
### [Example 2]
37+
38+
[Todo description]
39+
40+
```
41+
Code
42+
```
43+
44+
## Installing
45+
46+
In order to make the Supernova CSS exporter available for your organization so you can start generating code from your design system, please follow the installation guide in our [developer documentation](https://developers.supernova.io/using-exporters/installing-exporters).
47+
48+
## Reporting Bugs or Requesting Features
49+
50+
In order to faciliate easy communication and speed up delivery of fixes and features for this exporter, we require everyone to log all issues and feature requests through the issue tracking of this repository.
51+
52+
Please read through the [existing issues](../../issues) before you open a new issue! It might be that we have already discussed it before. If you are sure your request wasn't mentioned just yet, proceed to [open a new issue](../../issues) and fill in the required information. Thank you!
53+
54+
## Contributing
55+
56+
If you have an idea for improving this exporter package or want a specific issue fixed quickly, we would love to see you contribute to its development!
57+
58+
There are multiple ways you can contribute, so we have written a [contribution guide](https://developers.supernova.io/building-exporters/contribution-and-requests) that will walk your through the process. Any pull requests to this repository are very welcome.
59+
60+
## License
61+
62+
This exporter is distributed under the [MIT license](./LICENSE.md). [We absolutely encourage you](https://developers.supernova.io/building-exporters/cloning-exporters) to clone it and modify it for your purposes, so it fits the requirements of your stack. If you see that you have created something amazing in the process that others would benefit from, we strongly recommend you consider [publishing it back to the community](https://developers.supernova.io/building-exporters/sharing-exporters-with-others) as well.
63+
64+
## Useful Links
65+
66+
- To learn more about Supernova, [go visit our website](https://supernova.io)
67+
- To join our community of fellow developers where we try to push what is possible with design systems and code automation, join our [community discord](https://community.supernova.io)
68+
- To understand everything you can do with Supernova and how much time and resources it can save you, go read our [product documentation](https://learn.supernova.io/)
69+
- Finally, to learn everything about what exporters are and how you can integrate with your codebase, go read our [developer documentation](https://developers.supernova.io/)
70+
71+
## Other Supernova Exporters
72+
73+
We are developing and maintaining exporters for many major technologies. Here are all the official exporters maintained by Supernova:
74+
75+
- [iOS Exporter](https://github.com/Supernova-Studio/exporter-ios)
76+
- [iOS Localization Exporter](https://github.com/Supernova-Studio/exporter-ios-localization)
77+
- [Android Exporter](https://github.com/Supernova-Studio/exporter-android)
78+
- [React Exporter](https://github.com/Supernova-Studio/exporter-react)
79+
- [Flutter Exporter](https://github.com/Supernova-Studio/exporter-flutter)
80+
- [Angular Exporter](https://github.com/Supernova-Studio/exporter-angular)
81+
- [Typescript Exporter](https://github.com/Supernova-Studio/exporter-typescript)
82+
- [CSS Exporter](https://github.com/Supernova-Studio/exporter-css)
83+
- [LESS Exporter](https://github.com/Supernova-Studio/exporter-less)
84+
- [SASS Exporter](https://github.com/Supernova-Studio/exporter-sass)
85+
86+
87+
Additionally, we are also developing and maintaining exporters for specific use cases:
88+
89+
- [Style Dictionary Exporter](https://github.com/Supernova-Studio/exporter-style-dictionary)
90+
- [HTML Preview Exporter](https://github.com/Supernova-Studio/exporter-html-preview)
91+
92+
To browse all exporters created by our amazing community, please visit the [Supernova](https://supernova.io) Exporter Store.
93+
94+
95+
96+
97+
98+

‎exporter.json

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{
2+
"id": "io.supernova.css",
3+
"name": "CSS",
4+
"description": "CSS token and style exporter",
5+
"author": "Jiri Trecak",
6+
"organization": "Supernova",
7+
"homepage": "https://supernova.io",
8+
"source_dir": "src",
9+
"version": "1.0.0",
10+
"config": {
11+
"sources": "sources.json",
12+
"output": "output.json"
13+
},
14+
"engines": {
15+
"pulsar": "1.0.0",
16+
"supernova": "1.0.0"
17+
},
18+
"tags": [
19+
"Flutter"
20+
]
21+
}

‎icon.png

6.23 KB
Loading

‎output.json

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"blueprints": [
3+
{
4+
"invoke": "colors.pr",
5+
"write_to": "styles/colors.css"
6+
}
7+
]
8+
}

‎readme-icon.png

8.35 KB
Loading

‎sources.json

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{}

‎src/colors.pr

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{* Export example code goes here *}

0 commit comments

Comments
 (0)