Skip to content

Commit

Permalink
update contributing.md to explain updated LESS/CSS customization
Browse files Browse the repository at this point in the history
  • Loading branch information
williaster committed Mar 5, 2016
1 parent d3f7bbd commit 9095cd3
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 3 deletions.
13 changes: 11 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,16 +152,25 @@ Generate the documentation with:

cd docs && ./build.sh

## CSS Themes
As part of the npm build process, CSS for Panoramix is compiled from ```Less```, a dynamic stylesheet language.

It's possible to customize or add your own theme to Panoramix, either by overriding CSS rules or preferably
by modifying the Less variables or files in ```assets/stylesheets/less/```.

The ```variables.less``` and ```bootswatch.less``` files that ship with Panoramix are derived from
[Bootswatch](https://bootswatch.com) and thus extend Bootstrap. Modify variables in these files directly, or
swap them out entirely with the equivalent files from other Bootswatch (themes)[https://github.com/thomaspark/bootswatch.git]

## Pull Request Guidelines

Before you submit a pull request from your forked repo, check that it
Before you submit a pull request from your forked repo, check that it
meets these guidelines:

1. The pull request should include tests, either as doctests,
unit tests, or both.
2. If the pull request adds functionality, the docs should be updated
as part of the same PR. Doc string are often sufficient, make
as part of the same PR. Doc string are often sufficient, make
sure to follow the sphinx compatible standards.
3. The pull request should work for Python 2.6, 2.7, and ideally python 3.3.
`from __future__ import ` will be required in every `.py` file soon.
Expand Down
2 changes: 2 additions & 0 deletions panoramix/assets/stylesheets/less/index.less
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
// Index .less, any imports here will be included in the final css build

@import "~bootstrap/less/bootstrap.less";
@import "./variables.less";
@import "./bootswatch.less";
2 changes: 1 addition & 1 deletion panoramix/assets/stylesheets/less/variables.less
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Paper 3.3.6
// Modified from Bootswatch Paper 3.3.6
// Variables
// --------------------------------------------------

Expand Down

0 comments on commit 9095cd3

Please sign in to comment.