Customized SCSS/CSS

[ivanhercaz]

The user should be able to change the colors of the theme without modifying the theme itself. Thus it is very important to implement a way to use a customized stylesheet. It should address two possible situations:

User that prefers to use CSS directly

If the user will prefer to use CSS dircetly, it should have instructions about how to modify each thing in a custom stylesheet. The user should know the the pros and cons of this way:

• Pros. You can edit and use directly your CSS.
• Cons. It may be more complex to customize all Buruma.

User that prefers to use SCSS

If the user will prefer to use SCSS, the user would need to know a good way to convert SCSS into a CSS file. The user should know the pros and cons of this way:

• Pros. User can benefit of all the SCSS extension.
• Cons. User will need to convert SCSS to CSS to use it.
• Pros. Related with the cons, the process to build a CSS file from the SCSS might be easier investing a bit of time with the installation and configuring of some packages and scripts (take a look at package.json).
• Cons. Whatever the user uses, the user will need an extra configuration to work with SCSS.

Development

• Add way to integrate CUSTOM_CSS in base.html template: if CUSTOM_CSS exists, then add this <link ... />.

Documentation

• Document CUSTOM_CSS.
  • Pros and cons.
  • How-to add modifications to the theme.
• Document CUSTOM_SCSS.
  • Pros and cons.
  • How-to add modifications to the theme.
  • How-to build the CSS.
  • An easy solution: show how Buruma does it internally and how the user can apply it to its own site.

[ivanhercaz]

I think the plugin pelican-assets is very interesting for this issue.

[ivanhercaz]

@maciejmatczak, do you need urgently this to work with your site?

[maciejmatczak]

@ivanhercaz, made some dirty workaround :) with CUSTOM_CSS, I am good for now!