site/README.md

68 lines
3.6 KiB
Markdown
Raw Permalink Normal View History

2020-01-15 17:45:50 +03:00
<h1 align="center">
Сайт группы
</h1>
## Требования
- Node.js версии не ниже 8 и менеджер пакетов npm
- Gatsby CLI
- Git
## Запуск локально
2020-10-30 12:26:57 +03:00
Клонируем репозиторий, переходим в директорию сайта. Добавляем переменную окружения, в неё прописываем путь до npm.
Устанавливаем нужные пакеты командой `npm install`. Gatsby CLI устанавливается командой `npm install -g gatsby-cli`.
Открываем командную строку, в ней пишем:
2020-01-15 17:45:50 +03:00
```shell
gatsby develop
```
2020-10-30 12:26:57 +03:00
При успешном запуске будет виден порт, на котором запускается сайт (обычно это `http://localhost:8000`).
2020-01-15 17:45:50 +03:00
## Содержимое папки
├── src
├── components
2020-10-30 12:26:57 +03:00
├── content
2020-03-21 22:53:30 +03:00
├── files
2020-01-15 17:45:50 +03:00
├── images
2020-03-21 22:53:30 +03:00
├── intl
├── pages
2020-01-15 17:45:50 +03:00
├── styles
├── static
├── admin
2020-01-15 20:35:02 +03:00
├── files
├── images
2020-01-15 17:45:50 +03:00
├── .gitignore
├── gatsby-config.js
├── gatsby-node.js
├── package-lock.json
├── package.json
└── README.md
Все исходники лежат в `src`.
- **/components** - элементы страницы, такие как авигационная панель, подвал, основные стили._
2020-03-21 22:53:30 +03:00
- **/images** и **/files** - изображения и файлы, которые используются на сайте.
- **/intl** - содержит элементы локализации.
2020-01-15 17:45:50 +03:00
- **/pages** - основной контент, * *.js-файлы трогать не нужно.* Все markdown-файлы находятся в папке `content`
- **/styles** - стили сайта.
2020-01-16 08:31:26 +03:00
В `static` находятся настройки административной панели и статические файлы. В неё добавляются вручную такие файлы, как pdf-документы, в остальных случаях её трогать не нужно.
2020-01-15 17:45:50 +03:00
- Файл `gatsby-config.js` предназначен для внесения плагинов.
- В `gatsby-node.js` хранится код для преобразования .md-файлов в страницы.
2020-03-11 16:59:25 +03:00
## Деплой
Для деплоя сайта нужно в командной строке прописать `npm run deploy`.
2020-01-15 17:45:50 +03:00
## Редактирование
Для редактирования сайта существуют два способа: локально и с помощью Netlify CMS.
### **Локально**
2020-10-30 12:26:57 +03:00
1. В папке `/src/content` вносим изменения в существующие markdown-файлы, добавляем новые, удаляем ненужные.
2. Добавляем при необходимости изображения в папку `/src/images`.
3. В командной строке переходим в директорию сайта, запускаем `gatsby develop`, локально проверяем, как выглядит.
4. Делаем коммит изменений, пушим в репозиторий на Github на ветку dev.
2020-01-15 17:45:50 +03:00
### **С помощью Netlify CMS**
1. К пути сайта добавляем `/admin`, оказываемся в панели администратора.
2020-03-21 15:57:23 +03:00
2. Вносим нужные изменения.
3. Сохраняем.