https://github.com/vitalk/classy-style-guide
Base Styleguide layout
https://github.com/vitalk/classy-style-guide
Last synced: over 1 year ago
JSON representation
Base Styleguide layout
- Host: GitHub
- URL: https://github.com/vitalk/classy-style-guide
- Owner: vitalk
- Created: 2015-05-22T11:41:26.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2016-12-10T11:20:24.000Z (over 9 years ago)
- Last Synced: 2025-02-09T09:30:12.836Z (over 1 year ago)
- Language: CSS
- Size: 5.86 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Classy Styleguide
Base Styleguide layout inspired by the [GitHub Styleguide](https://github.com/styleguide).
## Installation
The recommended installation method is a [bower](http://bower.io).
```shell
bower install --save classy-style-guide
```
## Usage
```jinja
{{ section.section }}
{{ section.description|safe }}
{% if section.modifiers %}
{% for m in section.modifiers %}
-
{{ m.name }} - {{ m.description }}
{% endfor %}
{% endif %}
{{ section.example|safe }}
{% for m in section.modifiers %}
{{ m.name }}
{{ m.example|safe }}
{% endfor %}
{{ section.example|forceescape }}
```
Variable | Description
---|---
`@classy-style-guide-namespace` | The namespace uses for classy style guide class names (`style-guide` by default).
`#classy-style-guide-vars` | The custom namespace for related variables.
## License
Licensed under the [MIT license](http://mit-license.org/vitalk).