introduction

Help you launch your style guide site with django in KSS syntax. you can integrate the style giude in your site easily. I use it every day. feel free to give me any suggestion.

I now change the name to django-kss-styleguide https://pypi.python.org/pypi/django-kss-styleguide/

start

pip install django-kss-styleguide

Settings

in yout settings.py

Add the app,

INSTALLED_APPS += (
            "compressor",
    "django_kss",
)

Related Settings

in settings.py

because scss is very common, we support it via djagno compressor Add setting about django compressor.

COMPRESS_PRECOMPILERS = (
        ('text/x-scss', 'django_libsass.SassCompiler'),
)
STATICFILES_FINDERS = (
        'django.contrib.staticfiles.finders.FileSystemFinder',
        'django.contrib.staticfiles.finders.AppDirectoriesFinder',
        'compressor.finders.CompressorFinder',
)
#  Django Compressor for development. so it can put image to correct place
COMPRESS_ENABLED = True
COMPRESS_REBUILD_TIMEOUT = 0

STATIC_ROOT = '/tmp/root'

in your app.

add filename called styleguide.py in your app.

styleguide = {
        'source_dir': 'static/css',
        'verbose_name': 'Sample APP2',   #Optional
        'target_files': 'static/css/form.scss'  # optional
}

source_dir: Where you write you kss comment and css files

verbose_name: Your app name

target_files: If you use scss, put the scss file you want to compile

urls.py settings

Routing, add the following two lines in your project’s urls.py

import:

import django_kss.urls

add the url patterns:

url(r'^$', include(django_kss.urls)),

html

for F2E or designer

put your complete html in templates/prototype/

you can view it automatically in the site

Writing The KSS in your scss/less/css file

/*
Buttons

Styleguide 1
*/


/*
Your standard form button.

.btn-danger   -  danger
.btn-warning  -  warning
.btn-info     -  info


Example:
        <button class="liftedBtn $modifier_class" >按鈕</button>

Styleguide 1.1
*/

.liftedBtn{
        @extend .btn;
        position: relative;
        border-width: 0;
        letter-spacing: 1px;
        border-bottom-color: rgba(30,30,30,0.3);
        border-bottom-width: 0;
        transition: all 0.2s;
        bottom: 0;
        &:hover{
                bottom: $strong-border-width;
                border-bottom-width: $strong-border-width;
        }
}

One More Things

the base template is already integrate livereload.

to utilize livereload,

sudo pip install livereload

and type ‘livereload .’ in you repository root.

you can see all the braowser will reflect your change

Environment
- Web Environment
Framework
- Django
Intended Audience
- Developers
License
- OSI Approved :: BSD License
Operating System
- OS Independent
Programming Language
- Python
Topic
- Internet :: WWW/HTTP
- Internet :: WWW/HTTP :: Dynamic Content

Metadata

Environment
- Web Environment
Framework
- Django
Intended Audience
- Developers
License
- OSI Approved :: BSD License
Operating System
- OS Independent
Programming Language
- Python
Topic
- Internet :: WWW/HTTP
- Internet :: WWW/HTTP :: Dynamic Content

Release files for django-kss 0.5.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for django-kss 0.5.5
File	Size	Uploaded	Provenance
django-kss-0.5.5.tar.gz	46.0 kB	Feb 9, 2015	Without provenance	Details

Built distribution (wheel)

Table of built distributions (wheels) for django-kss 0.5.5
File	Interpreter	ABI	Platform	Reset
django-kss-0.5.5.macosx-10.10-intel.tar.gz 92.2 kB Feb 9, 2015 Without provenance				Details

Total release size: 138.2 kB

Release files / django-kss-0.5.5.tar.gz

Download URL	django-kss-0.5.5.tar.gz
Size	46.0 kB
Tags	Source
SHA-256 checksum How to use checksums	`0891ee2f1d263722c64cf1a11313332e7851312745bbb471648cea0750a9c81d`
BLAKE2b-256 checksum How to use checksums	`8ad4670381b69c29228ffc28f9aa9496662454cb79a52415443902e5abf9a796`
Upload date	Feb 9, 2015
Uploaded using Trusted Publishing? What is trusted publishing?	No

Release files / django-kss-0.5.5.macosx-10.10-intel.tar.gz

Download URL	django-kss-0.5.5.macosx-10.10-intel.tar.gz
Size	92.2 kB
Tags	Source
SHA-256 checksum How to use checksums	`26ed488ee6c6abbfed3eeddaf5275d314bbfed6a7b8a509ff5b42c35fd676693`
BLAKE2b-256 checksum How to use checksums	`75063534da424cb06629efae36a481fb1489eafc529e08f4fef7deeadd1f063f`
Upload date	Feb 9, 2015
Uploaded using Trusted Publishing? What is trusted publishing?	No

Security for django-kss 0.5.5

Report project as malware

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.