Metadata-Version: 2.1
Name: odoo13-addon-website-critical-css
Version: 13.0.2.0.2.dev3
Summary: Website Critical CSS to improve FCP score
Home-page: https://github.com/OCA/website
Author: Sunflower IT,Odoo Community Association (OCA)
Author-email: support@odoo-community.org
License: AGPL-3
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Framework :: Odoo
Classifier: Framework :: Odoo :: 13.0
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Requires-Python: >=3.5
Requires-Dist: odoo <13.1dev,>=13.0a

====================
Website Critical CSS
====================

.. 
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! This file is generated by oca-gen-addon-readme !!
   !! changes will be overwritten.                   !!
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! source digest: sha256:9850d66a689d96ae8615385d41e7c0e0d314a5ebed9b598c366c284c7f9c6f06
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
    :target: https://odoo-community.org/page/development-status
    :alt: Beta
.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
    :alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fwebsite-lightgray.png?logo=github
    :target: https://github.com/OCA/website/tree/13.0/website_critical_css
    :alt: OCA/website
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
    :target: https://translation.odoo-community.org/projects/website-13-0/website-13-0-website_critical_css
    :alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
    :target: https://runboat.odoo-community.org/builds?repo=OCA/website&target_branch=13.0
    :alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

This module can improve the Google PageSpeed score of individual website pages.

In particular, it improves the score for First Contentful Paint (FCP). It does so
by allowing to configure a blob of 'Critical CSS' for each page, which is the only
CSS that will be loaded before first paint. Any other CSS is delayed.

**Table of contents**

.. contents::
   :local:

Usage
=====

To use this module:

  * Go to Website -> Pages and select a page to optimize
  * Clear out any current contents of the 'Critical CSS' field
  * Find out the public facing URL of this page
  * Generate Critical CSS for this URL while selecting the right widths for
    Desktop and Mobile views
  * Paste the blob in the 'Critical CSS' field.

To generate critical CSS you have a couple of options:

  * Use a free online Critical CSS generator. At the time of writing
    there are: Sitelocity, Pegasaas, web.dev, Corewebvitals.io, ...
  * Install the npm [critical](https://github.com/addyosmani/critical)
    package and generate it on your local.

To test improvement of FCP score, use for example Lighthouse, which is
build into Chrome browser.

Known issues / Roadmap
======================

* Support automatic critical CSS generation when page layout is
  changed, when the `critical` tool is installed on server.
* Investigate possible incompatibility with `web_company_color`
  Both are overriding the same function in `ir.qweb`

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/website/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/website/issues/new?body=module:%20website_critical_css%0Aversion:%2013.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

Do not contact contributors directly about support or help with technical issues.

Credits
=======

Authors
~~~~~~~

* Sunflower IT

Contributors
~~~~~~~~~~~~

* Dan Kiplangat <dan@sunflowerweb.nl>
* Tom Blauwendraat <tom@sunflowerweb.nl>

Maintainers
~~~~~~~~~~~

This module is maintained by the OCA.

.. image:: https://odoo-community.org/logo.png
   :alt: Odoo Community Association
   :target: https://odoo-community.org

OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.

This module is part of the `OCA/website <https://github.com/OCA/website/tree/13.0/website_critical_css>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.


