-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit e3bcc96
Showing
19 changed files
with
16,143 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
node_modules | ||
.build | ||
build |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# Changelog | ||
|
||
All notable changes to this exporter are mentioned here in this file. | ||
|
||
## [1.0.0] - 2023-10-09 | ||
### Initial version | ||
|
||
The initial version of the XLiff exporter. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
MIT License | ||
|
||
Copyright (c) 2021-present Supernova and other contributors | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining | ||
a copy of this software and associated documentation files (the | ||
"Software"), to deal in the Software without restriction, including | ||
without limitation the rights to use, copy, modify, merge, publish, | ||
distribute, sublicense, and/or sell copies of the Software, and to | ||
permit persons to whom the Software is furnished to do so, subject to | ||
the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be | ||
included in all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, | ||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF | ||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND | ||
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE | ||
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION | ||
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION | ||
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
<img src="https://raw.githubusercontent.com/Supernova-Studio/exporter-documentation/master/readme-icon.png" alt="Supernova Logo" style="max-width:100%;"> | ||
|
||
[Supernova](https://supernova.io) is a design system platform that allows you to seamlessly translate your design system data to production-ready code, document your decisions, and build design system tools on top of a thriving ecosystem. 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/). | ||
|
||
# XLiff Exporter | ||
|
||
The exporter allows you to export XLiff localization files from the documentation built inside Supernova Docs exporter. Simply run the exporter, and import the XLiff to your localization workbench to kickstart your localization efforts. | ||
|
||
## Installing | ||
|
||
In order to make the Supernova XLiff 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). | ||
|
||
## Reporting Bugs or Requesting Features | ||
|
||
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. | ||
|
||
Please read through the [existing issues](https://github.com/Supernova-Studio/exporter-documentation/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](https://github.com/Supernova-Studio/exporter-documentation/issues) and fill in the required information. Thank you! | ||
|
||
## Contributing | ||
|
||
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! | ||
|
||
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. | ||
|
||
## License | ||
|
||
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. | ||
|
||
## Useful Links | ||
|
||
- To learn more about Supernova, [go visit our website](https://supernova.io) | ||
- 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) | ||
- 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/) | ||
- 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/) | ||
|
||
## Other Supernova Exporters | ||
|
||
We are developing and maintaining exporters for many major technologies. Here are all the official exporters maintained by Supernova: | ||
|
||
- [iOS Exporter](https://github.com/Supernova-Studio/exporter-ios) | ||
- [iOS Localization Exporter](https://github.com/Supernova-Studio/exporter-ios-localization) | ||
- [Android Exporter](https://github.com/Supernova-Studio/exporter-android) | ||
- [React Exporter](https://github.com/Supernova-Studio/exporter-react) | ||
- [Flutter Exporter](https://github.com/Supernova-Studio/exporter-flutter) | ||
- [Angular Exporter](https://github.com/Supernova-Studio/exporter-angular) | ||
- [Typescript Exporter](https://github.com/Supernova-Studio/exporter-typescript) | ||
- [CSS Exporter](https://github.com/Supernova-Studio/exporter-css) | ||
- [LESS Exporter](https://github.com/Supernova-Studio/exporter-less) | ||
- [SASS Exporter](https://github.com/Supernova-Studio/exporter-sass) | ||
|
||
Additionally, we are also developing and maintaining exporters for specific use cases: | ||
|
||
- [Style Dictionary Exporter](https://github.com/Supernova-Studio/exporter-style-dictionary) | ||
- [HTML Preview Exporter](https://github.com/Supernova-Studio/exporter-html-preview) | ||
|
||
To browse all exporters created by our amazing community, please visit the [Supernova](https://supernova.io) Exporter Store. |
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
{ | ||
"id": "io.supernova.xliff", | ||
"name": "XLiff exporter", | ||
"description": "Export all documentation texts into XLiff format for localization purposes", | ||
"author": "Supernova", | ||
"organization": "Supernova", | ||
"source_dir": "src", | ||
"assets_dir": "assets", | ||
"version": "1.0.0", | ||
"usesBrands": false, | ||
"config": { | ||
"sources": "sources.json", | ||
"output": "output.json", | ||
"js": "src/js_helpers.js" | ||
}, | ||
"engines": { | ||
"pulsar": "1.0.0", | ||
"supernova": "1.0.0" | ||
}, | ||
"type": "code", | ||
"tags": [ | ||
"Documentation", | ||
"Localization", | ||
"XLiff" | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
{ | ||
"blueprints": [{ | ||
"invoke": "xliff_index.pr", | ||
"write_to": "strings.xliff", | ||
"comment": "Create XLiff representation of the documentation content" | ||
}] | ||
} |
Oops, something went wrong.