Welcome to the documentation for django-styleguide!
- Develop an evolving foundation of base HTML/CSS patterns
- They can be styled and extended to meet the needs of specific projects
- The result, a live style guide, is embedded in the Django project and uses the project CSS
- A complementary tool to django-comps, which is for building full pages
- Installed via a pluggable Django app
- Possible to add to existing projects
- Accessible on staging server to show clients (e.g. /style-guide/)
- Bundled into the django-project-template
- Enabled automatically within the template
- Uses project styles
- All simple Django templates
- Uses project CSS files directly so style guide and project run on same code
- Easily extensible when adding new project patterns/widgets
- No URLs/views
- Just drop a new HTML/CSS template into a specific directory
- Style guide menu is auto generated from file structure and adds new menu items
- Show how to use widgets
- Copy/pasteable code snippets with syntax highlighting
Styleguide provides both a mechanism to create styleguides for areas of your website or types of elements in your design and also provides a few starter styleguides. To use the starter styleguides, first see which ones are present.
python manage.py listpatterns
The listpatterns command will give you a list of the styleguides that come from django-styleguide itself. If you want to customize any of these, you can use the copypattern command to copy it into your own project.
python manage.py copypattern [patternname]
Patterns will be copied into project/templates/styleguide/ and can be edited to change the pattern for your own project.
Pattern templates are automatically served under the /styleguide/ URL where /styleguide/forms/ will render the pattern template from /project/templates/styleguide/styleguide-forms.html.
You can run the tests with via:
python setup.py test
or:
python runtests.py
django-styleguide is released under the BSD License. See the LICENSE file for more details.
If you think you've found a bug or are interested in contributing to this project check out django-styleguide on Github.
Development sponsored by Caktus Consulting Group, LLC.