Hello everybody!

This project is the personal work of one junior

The essence is as follows:

• Perform the function of classic css style reset(reset.css) within scss
• Perform the function of providing basic and minimal styling settings on the site (including resetting the original styles)
• At the same time, you need the ability to control variables inside the scss library

Этот проект является личной наработкой одного джуниора

Суть состоит в следующем:

• Выполнять функцию классического сброса стилей css(reset.css) в рамках scss
• Выполнять функцию по предоставлению базовой и минимальной настройкой стилистики на сайте(включая сброс первоначальных стилей)
• При этом, нужна возможность контролировать переменные внутри scss библиотеки

Как это работает?

Скачиваете пакет из npm:

npm i -d @neat-core/footing-styles

Далее прописываете в своём корневом index.scss файле следующие строки:

@use '@neat-core/footing-styles';

Всё. По умолчанию будет применятся только сброс стилей по умолчанию. Он включает в себя так же: кастомизацию скроллбара для разных устройств, кастомизацию при выделении текста, добавление возможности работы с rem.

Чтобы добавить базовые чуть улучшенные стили, сделайте следующее:

@use '@neat-core/footing-styles/vars' with (
    $mode: "pretty", // Если хотите оставить только сброс стилей, 
                        // либо поменяйте значение на `default`
                        // либо просто уберите данную строку
    $color-primary: #dc3545 
);

@use '@neat-core/footing-styles';

Можно менять следующий список переменных:

Для цветов(префикс color-*):

secondary primary success info warning danger light dark text text-secondary selection selection-bg track thumb

Для шрифтов(префикс font-*):

family size line-height line-height-h

Для пельменей в препроцессорах CSS

Если вы не используете scss, и вам нужно просто добавить какую либо из этих конфигураций как статичный css, то делаем так:

@import '@neat-core/footing-styles/default'; /* Обычный сброс */
@import '@neat-core/footing-styles/pretty' ; /* Чуть симпатичнее сброс */

Пока что, мне больше добавить нечего, к сожалению. Опыта в написании документации у меня - 0, но я учусь)

Не ругайте если что то не так, создавайте issue в репозитории проекта и мы обязательно обсудим что не так, а что можно и улучшить.

Всех славного кодинга!