Skip to content

Commit

Permalink
More about overwriting style
Browse files Browse the repository at this point in the history
  • Loading branch information
Koen Van Daele committed Sep 7, 2016
1 parent 66778d7 commit 500bce1
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions docs/source/customisation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,11 @@ virtual environment.
$ pip install -r requirements-dev.txt
# compile the Message Catalog Files
$ python setup.py compile_catalog
# Download and install client side libraries
$ cd my_thesaurus/static
$ bower install
$ cd admin
$ bower install
This gives you a clean slate to start your customisations on. By default the
scaffold comes with a simple SQLite database. This is more than enough for
Expand Down Expand Up @@ -300,6 +305,44 @@ Selecting which conceptschemes receive this focus is done in your
This should be a space or newline delimited list, limited to 4 entries.

Changing the CSS
----------------

Out of the box, Atramhasis, comes with the Zurb Foundation framework. We have
created a custom style for this framework, but as always you are free to modify
this style. Your custom instance contains a few extension points that make it
easy to override and change style elements without having to rewrite to much
css. All style related files can be found in the :file:`my_thesaurus/static`
folder. This project's CSS is being maintained and generated by `Compass`. You
will find a :file:`scss` folder that contains three files that can be used for
easy customisations: :file:`_my_thesaurus-settings.scss`,
:file:`_my_thesaurus.scss` and :file:`_my_thesaurus-admin.scss`. The first file
is a settings file that allows you to override a lot of variables that are used
in generating the css. Suppose you want to override the default row width and
the default font. You would change :file:`_my_thesarus-settings.scss` to the
following:

.. code-block:: scss
// Custom SASS code for my_thesaurus
$row-width: rem-calc(1140);
$body-font-family: "museo-sans", "Open Sans", "Helvetica", Helvetica, Arial, sans-serif;
To have you changes take effect, you need to recompile the scss files and
restart your webserver.

.. code-block:: bash
$ compass compile
write css/app-admin.css
write css/app.css
The other two files, :file:`_my_thesaurus.scss` and
:file:`_my_thesaurus-admin.scss` are the final scss files loaded before
compiling them and can be used to overwrite things in the public or admin
interface.


.. _security:

Expand Down

0 comments on commit 500bce1

Please sign in to comment.