Документация

📚 Простая и удобная документация проекта (пока в разработке).

📥 Клонирование

Для клонирования проекта необходимо иметь установленный git. Если он установлен, то просто выполните команду в терминале:

git clone https://github.com/91muilak/docs

📦 Сборка

Для сборки проекта необходим пакетный менеджер npm, который устанавливается вместе с NodeJS. Если npm уже установлен, то откройте в терминале папку проекта и выполните команду:

npm install

Команда установит:

• sass чтобы скомпилировать SASS в CSS;
• @11ty/eleventy для генерации статики;
• @11ty/eleventy-plugin-syntaxhighlight для подсветки синтаксиса кода в HTML;
• @rx1310/kalium19 для миксинов и других утилит SASS;

Команды npm:

• npm run start - вотчинг изменений в файлах и мгновенная компиляция (для локальной разработки);
• npm run build - сборка проекта (для сервера/CI);

👥 Комьюнити

Я буду рад получить от вас фидбек или какую-либо помощь для улучшения проекта. Идеи 💡, код 👩‍💻, советы 👌 и всё что только можно - я буду рад 😊.

📜 Лицензия

Проект распространяется по свободной лицензии MIT.

MIT License

Copyright (c) 2021 The Kalium19 Project Authors

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.