Репозиторий с исходным кодом персонального сайта Асхаба Кудзаева (rx1310).
Для клонирования репозитория необходимо иметь установленный Git.
-
Клонирование репозитория выполняется командой в терминале:
git clone https://github.com/rx1310/rx1310.github.io.git
Если используется SSH, то:
git clone [email protected]:rx1310/rx1310.github.io.git
Если используется GitHub CLI
gh repo clone rx1310/rx1310.github.io
-
Переходим в основную ветку для разработки (develop)
git checkout develop
-
Готово!
В репо есть три основных ветки:
| Ветка | Краткое описание |
|---|---|
| develop | используется для разработки |
| main | ветка для окончательной версии |
| redirect | не используется в разработке и предназначен только для редиректа с GH Pages на основной домен. |
Сборкой проекта занимается генератор статики Eleventy. Скрипты для сборки и разработки прописаны в файле package.json.
Команды npm прописываются в терминале:
npm run <команда>Вот список доступных команд для разработки:
| Команда | Что делает? |
|---|---|
start |
запускает сервер 11ty и вотчер SASS |
build |
запускает сборку 11ty и SASS |
11ty:serve |
запускает сервер 11ty (BrowserSync) |
11ty:build |
собирает 11ty (шаблоны и тп.) |
sass:watch |
запускает вотчер SASS |
sass:build |
собирает SASS в CSS |
В этом пункте расписаны те инструменты, которые используются непосредственно для разработки.
Разработка проекта ведется в редакторе кода Visual Studio Code, для которого уже прописаны все необходимые для проекта конфиги в папке .vscode.
.vscode/
├── extensions.json (рекомендуемые расширения для VSCode)
├── other.code-snippets (прочие сниппеты)
├── sass.code-snippets (сниппеты для SASS)
└── settings.json (настройки проекта для редактора)
По умолчанию в редакторе скрыты некоторые маловажные папки и файлы. Настроить их отображение можно в файле .vscode/settings.json:
"files.exclude": {
"dist/" : false,
".github/" : true,
"node_modules" : true,
".ecrc" : true,
".editorconfig" : true,
".eleventyignore": true,
"package-lock.*" : true,
".gitignore" : true,
"LICENSE" : true
},Если значение
true- скрыто, еслиfalse- не скрыто, что логично.
Необходимо также иметь установленный NodeJS на компьютере для полноценной работы Eleventy, SASS и других плагинов.
Менеджер пакетов npm должен сам установиться вместе с NodeJS.
Eleventy (11ty) — это статический генератор сайтов, который сейчас набирает популярность. Его используют Google, Khan Academy, Netlify и другие.
Конфиги для 11ty находятся в файле .11ty.js.
- основная папка (input): app/
- папка, в которую собирается проект (output): dist/
- папка с данными (data): app/data/
dir: {
input: 'app',
output: 'dist',
includes: 'includes/',
layouts: 'layouts/',
data: "data"
},Проект rx1310.github.io распространяется совершенно бесплатно и находится под защитой лицензии Apache-2.0.
Инструментарий, используемый в разработке, распространяется по указанной автором / компанией / разработчиком лицензии, не зависящей от этого проекта.
Apache License, Version 2.0
Copyright 2022 Haba Kudzaev (rx1310) <[email protected]>
Если Вы нашли нарушение чьей-либо лицензии в моем проекте, то просьба написать мне → Telegram, эл. почта или VK.