https://github.com/crabnebula-dev/style-guide
CrabNebula's style-guide
https://github.com/crabnebula-dev/style-guide
Last synced: 6 months ago
JSON representation
CrabNebula's style-guide
- Host: GitHub
- URL: https://github.com/crabnebula-dev/style-guide
- Owner: crabnebula-dev
- License: agpl-3.0
- Created: 2023-05-11T16:25:00.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-07T01:16:12.000Z (almost 3 years ago)
- Last Synced: 2025-07-21T11:45:39.247Z (about 1 year ago)
- Language: SCSS
- Homepage: https://crabnebula.dev
- Size: 1.57 MB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# style-guide
This repository contains SASS that's used to generate common CSS styles that can be shared across the product
(platform, devrel, security, etc).
**Why SASS?**
Currently, we use a number of different component libraries across our products. This allows our teams to experiment
around with different tools and frameworks to figure out which one works best for them. To avoid prescribing a solution
we decided to generate CSS as a stepping stone to a more thorough component library.
## Installation
Currently, the assets need to be installed using git+ssh. To do this, add the following to your `package.json` file and
then install using `npm i` or `pnpm i`.
```json
{
// ...
"dependencies": {
// ...
"@crabnebula-dev/style-guide": "http://github.com/crabnebula-dev/style-guide.git#main"
}
}
```
## Documentation
Until we get this shipped somewhere, you'll need to spin up a local server to access docs. This will also perform live
recompilation of scss files and automatic rebuilding of the docs.
```shell
npm run serve
```
## Resources
- [addlicense](https://github.com/google/addlicense)
## License
```
Copyright (C) 2023 CrabNebula Ltd.
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see .
```