NPM/site
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
сайт группы
140 Commits 2 Branches 0 Tags 60 MiB
JavaScript 47.5%
SCSS 34.4%
HTML 18.1%
51340e23dc
Go to file
Alexander Nozik 51340e23dc
Merge pull request #16 from mipt-npm/magprog 
Magprog
2021-03-29 23:12:40 +03:00
.github/workflows Update gatsby.yml 2021-03-29 13:59:38 +03:00
src Fix site title 2021-03-29 23:08:02 +03:00
static/admin fix styles 2021-03-29 23:00:58 +03:00
.gitignore Source structure refactoring 2020-08-24 14:46:46 +03:00
.graphqlconfig Source structure refactoring 2020-08-24 14:46:46 +03:00
gatsby-config.js fix styles 2021-03-29 23:00:58 +03:00
gatsby-node.js New style for magprog 2021-03-28 21:32:20 +03:00
gatsby-ssr.js styles fix, reduced size of pages 2020-03-22 22:13:40 +03:00
package.json fix styles 2021-03-29 23:00:58 +03:00
README.md Upd English version and readme 2020-10-30 12:26:57 +03:00
yarn.lock fix styles 2021-03-29 23:00:58 +03:00

README.md

Сайт группы

Требования

  • Node.js версии не ниже 8 и менеджер пакетов npm
  • Gatsby CLI
  • Git

Запуск локально

Клонируем репозиторий, переходим в директорию сайта. Добавляем переменную окружения, в неё прописываем путь до npm. Устанавливаем нужные пакеты командой npm install. Gatsby CLI устанавливается командой npm install -g gatsby-cli.

Открываем командную строку, в ней пишем:

gatsby develop

При успешном запуске будет виден порт, на котором запускается сайт (обычно это http://localhost:8000).

Содержимое папки

├── src
    ├── components
    ├── content
    ├── files
    ├── images
    ├── intl
    ├── pages
    ├── styles
├── static
    ├── admin
    ├── files
    ├── images
├── .gitignore
├── gatsby-config.js
├── gatsby-node.js
├── package-lock.json
├── package.json
└── README.md

Все исходники лежат в src.

  • /components - элементы страницы, такие как навигационная панель, подвал, основные стили.
  • /images и /files - изображения и файлы, которые используются на сайте.
  • /intl - содержит элементы локализации.
  • /pages - основной контент, * .js-файлы трогать не нужно. Все markdown-файлы находятся в папке content
  • /styles - стили сайта.

В static находятся настройки административной панели и статические файлы. В неё добавляются вручную такие файлы, как pdf-документы, в остальных случаях её трогать не нужно.

  • Файл gatsby-config.js предназначен для внесения плагинов.
  • В gatsby-node.js хранится код для преобразования .md-файлов в страницы.

Деплой

Для деплоя сайта нужно в командной строке прописать npm run deploy.

Редактирование

Для редактирования сайта существуют два способа: локально и с помощью Netlify CMS.

Локально

  1. В папке /src/content вносим изменения в существующие markdown-файлы, добавляем новые, удаляем ненужные.
  2. Добавляем при необходимости изображения в папку /src/images.
  3. В командной строке переходим в директорию сайта, запускаем gatsby develop, локально проверяем, как выглядит.
  4. Делаем коммит изменений, пушим в репозиторий на Github на ветку dev.

С помощью Netlify CMS

  1. К пути сайта добавляем /admin, оказываемся в панели администратора.
  2. Вносим нужные изменения.
  3. Сохраняем.