kopia lustrzana https://github.com/wagtail/wagtail
Docs: Update CSS Guidelines to align with new shared config
- also make changes to set up similar sections to JS docspull/5313/head
rodzic
c51147e643
commit
cbe8020527
|
@ -1,7 +1,7 @@
|
||||||
CSS coding guidelines
|
CSS coding guidelines
|
||||||
===========================
|
===========================
|
||||||
|
|
||||||
Our CSS is written in Sass, using the SCSS syntax.
|
Our CSS is written in `Sass <https://sass-lang.com/>`_, using the SCSS syntax.
|
||||||
|
|
||||||
Compiling
|
Compiling
|
||||||
~~~~~~~~~
|
~~~~~~~~~
|
||||||
|
@ -32,13 +32,16 @@ automatically recompiling when any changes are observed, by running:
|
||||||
$ npm start
|
$ npm start
|
||||||
|
|
||||||
|
|
||||||
Linting SCSS
|
Linting and formatting SCSS
|
||||||
~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
Wagtail uses the `stylelint <https://stylelint.io/>`_ linter.
|
Wagtail uses the `stylelint <https://stylelint.io/>`_ linter.
|
||||||
You'll need Node.js and npm on your development machine.
|
You'll need Node.js and npm on your development machine.
|
||||||
Ensure project dependencies are installed by running ``npm install --no-save``
|
Ensure project dependencies are installed by running ``npm install --no-save``
|
||||||
|
|
||||||
|
Linting code
|
||||||
|
------------
|
||||||
|
|
||||||
Run the linter from the wagtail project root:
|
Run the linter from the wagtail project root:
|
||||||
|
|
||||||
.. code-block:: console
|
.. code-block:: console
|
||||||
|
@ -49,12 +52,27 @@ Run the linter from the wagtail project root:
|
||||||
The linter is configured to check your code for adherance to the guidelines
|
The linter is configured to check your code for adherance to the guidelines
|
||||||
below, plus a little more.
|
below, plus a little more.
|
||||||
|
|
||||||
|
Formatting code
|
||||||
|
---------------
|
||||||
|
|
||||||
If you want to autofix errors, you can run that command directly with:
|
If you want to autofix errors, you can run that command directly with:
|
||||||
|
|
||||||
.. code-block:: console
|
.. code-block:: console
|
||||||
|
|
||||||
$ npm run lint:css -- --fix
|
$ npm run lint:css -- --fix
|
||||||
|
|
||||||
|
Changing the linter configuration
|
||||||
|
---------------------------------
|
||||||
|
|
||||||
|
To edit ignored files, add an entry to the ``.stylelintrc.yaml`` file under ``ignoreFiles``.
|
||||||
|
|
||||||
|
To the configuration for the linting rules is managed in an external
|
||||||
|
repository so that it can be easily shared across other Wagtail projects
|
||||||
|
or plugins. This configuration can be found at
|
||||||
|
`stylelint-config-wagtail <https://github.com/wagtail/stylelint-config-wagtail>`_.
|
||||||
|
|
||||||
|
Styleguide Reference
|
||||||
|
~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
Spacing
|
Spacing
|
||||||
-------
|
-------
|
||||||
|
|
Ładowanie…
Reference in New Issue