66 lines
3.6 KiB
Markdown
66 lines
3.6 KiB
Markdown
|
<h1 align="center">
|
|||
|
|
Сайт группы
|
|||
|
|
</h1>
|
|||
|
|
|
|||
|
|
## Требования
|
|||
|
|
- Node.js версии не ниже 8 и менеджер пакетов npm
|
|||
|
|
- Gatsby CLI
|
|||
|
|
- Git
|
|||
|
|
|
|||
|
|
## Запуск локально
|
|||
|
|
Клонируем репозиторий, переходим в директорию сайта. Добавляем переменную окружения, в неё прописываем путь до npm. Устанавливаем нужные пакеты командой `npm install`. Открываем командную строку, в ней пишем:
|
|||
|
|
```shell
|
|||
|
|
gatsby develop
|
|||
|
|
```
|
|||
|
|
При успешном запуске будет виден порт, на котором нужно запускать сайт (обычно это `htpp://localhost:8000`).
|
|||
|
|
|
|||
|
|
## Содержимое папки
|
|||
|
|
|
|||
|
|
├── src
|
|||
|
|
├── components
|
|||
|
|
├── pages
|
|||
|
|
├── images
|
|||
|
|
├── styles
|
|||
|
|
├── static
|
|||
|
|
├── admin
|
|||
|
|
├── files
|
|||
|
|
├── images
|
|||
|
|
├── .gitignore
|
|||
|
|
├── .prettierrc
|
|||
|
|
├── gatsby-config.js
|
|||
|
|
├── gatsby-node.js
|
|||
|
|
├── gatsby-ssr.js
|
|||
|
|
├── assets.bat
|
|||
|
|
├── package-lock.json
|
|||
|
|
├── package.json
|
|||
|
|
└── README.md
|
|||
|
|
|
|||
|
|
Все исходники лежат в `src`.
|
|||
|
|
- **/components** - элементы страницы, такие как _навигационная панель, подвал, основные стили._
|
|||
|
|
- **/images** - изображения, которые используются на сайте.
|
|||
|
|
- **/pages** - основной контент, * *.js-файлы трогать не нужно.* Все markdown-файлы находятся в папке `content`
|
|||
|
|
- **/styles** - стили сайта.
|
|||
|
|
|
|||
|
|
В `static` находятся настройки административной панели и статические файлы. В неё добавляются вручную такие файлы, как pdf-документы, в остальных случаях её трогать не нужно.
|
|||
|
|
|
|||
|
|
- Файл `gatsby-config.js` предназначен для внесения плагинов.
|
|||
|
|
- В `gatsby-node.js` хранится код для преобразования .md-файлов в страницы.
|
|||
|
|
- `gatsby-ssr.js` содержит внешние скрипты.
|
|||
|
|
|
|||
|
|
## Деплой
|
|||
|
|
Для деплоя сайта нужно в командной строке прописать `npm run deploy`.
|
|||
|
|
|
|||
|
|
## Редактирование
|
|||
|
|
Для редактирования сайта существуют два способа: локально и с помощью Netlify CMS.
|
|||
|
|
|
|||
|
|
### **Локально**
|
|||
|
|
1. В папке `/content` вносим изменения в существующие markdown-файлы, добавляем новые, удаляем ненужные.
|
|||
|
|
2. Добавляем при необходимости изображения в папку `/images`.
|
|||
|
|
3. Запускаем `assets.bat` для предотвращения проблем с файлами.
|
|||
|
|
4. В командной строке переходим в директорию сайта, запускаем `gatsby develop`, локально проверяем, как выглядит.
|
|||
|
|
5. Делаем коммит изменений, пушим в репозиторий на Github на ветку dev.
|
|||
|
|
|
|||
|
|
### **С помощью Netlify CMS**
|
|||
|
|
1. К пути сайта добавляем `/admin`, оказываемся в панели администратора.
|
|||
|
|
2. Вносим нужные изменения.
|
|||
|
|
3. Сохраняем.
|