npm install -S @weboops/core
- build - в этом режиме weboops просто собирает сайт и складывает файлы в папку public.
- development - собирает сайт и следит за всеми изменениями
Чтобы указать режим, нужно добавить параметр --mode при запуске. Вот как может выглядеть package.json:
...
"scripts": {
"build": "weboops --mode build",
"dev": "weboops --mode development"
}
...
Weboops будет искать все исходники в папке source. Уже в папке source должны быть следующие папки:
- pages - тут должны находиться файлы для отдельных страниц сайта в формате pug. Каждая из страниц будет доступна по соответствующему url. Например, если есть файл about.pug, страница about, будет доступна по адресу localhost:3000/about.
- stylesheets - в эту папку можно сложить css-файлы. Уже внутри этих файлов могут быть импорты других css-файлов.
- components - отдельные компоненты сайта. Компонент может содержать шаблон в формате pug, стили, картинки и т.д. - всё что относится к компоненту.
Сайт может содержать разные статические файлы, такие как, например, шрифты, фавиконки, картинки, robots.txt, карту сайта и т.д. Все эти файлы нужно положить в папку static рядом с source. Все они будут доступны так, как-будто лежат в корне сайта. Например, если в static, есть файл с именем images/doctor.jpg, внутри шаблона эту картинку можно подключить так:
<img src="/images/doctor.jpg" alt="Doctor" />