https://github.com/linkorb/stylex
Style guide toolkit for X (everything)
https://github.com/linkorb/stylex
Last synced: 8 months ago
JSON representation
Style guide toolkit for X (everything)
- Host: GitHub
- URL: https://github.com/linkorb/stylex
- Owner: linkorb
- License: mit
- Created: 2018-10-28T14:54:52.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-10-28T14:55:19.000Z (over 7 years ago)
- Last Synced: 2025-07-15T04:25:36.132Z (12 months ago)
- Language: PHP
- Homepage:
- Size: 7.81 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Stylex
======
Styleguide toolkit for X (everything)
## Use-cases:
* Language styleguides (i.e. php, javascript, markdown, etc)
* Organization specific coding conventions
* File formatting styleguides (i.e. whitepace usage in YAML files, etc)
* Technical writing style guide
* Tone-of-Voice style guide
* Branding style guide (usage of logos, brand colors, fonts, etc)
## Usage
Globally install stylex through composer:
composer global require linkorb/stylex
Now `cd` into a `-style-guide` directory and run:
stylex template path-to-my-templates build/
The `template` command will load the style guide files (yaml, json, md, etc) from the current directory, and run them through the (handlebars) templates in your template directory.
The generated output files will be saved in `build/`
## Example
Check out the `example/` directory.
To build this style-guide, simply run:
cd example/
../bin/stylex template ../templates/basic/ build/
open build/index.md
## Awesome style guides:
* [StyleGuide.io](http://styleguides.io/)
* [Mailchimp's Content Style Guide](https://styleguide.mailchimp.com/)
* [Atlassian Design](https://atlassian.design/)
* [Atlassian Product Style Guide](https://atlassian.design/guidelines/product/overview)
* [Google Developer Documentation Style Guide](https://developers.google.com/style/)
Want to suggest other awesome style guides for this sections? Just send a PR!
## License
MIT (see [LICENSE.md](LICENSE.md))
## Brought to you by the LinkORB Engineering team
Check out our other projects at [linkorb.com/engineering](http://www.linkorb.com/engineering).
Btw, we're hiring!