Flixel | аддонс | UI | Демо Инструменты | шаблоны | Документы | haxeflixel.com
Это источник haxeflixel.com. Он использует 11Ty для статического генерации сайтов и Bootstrap 5 для стиля.
У вас должен быть NPM / Nodejs, чтобы скомпилировать сайт, приглашаются запросы на вытяжение.
Установите Nodejs
Клонировать и запустить сайт
git clone https://github.com/HaxeFlixel/haxeflixel.com.git
cd haxeflixel.comЧтобы установить зависимости и создать сайт, запустите следующие команды:
# downloads dependencies, and clones flixel-docs
npm install
# runs the start command from package.json, which boots up the static site generator and scss styling for live reload
npm run startОткройте http: // localhost: 8080/
Начните взломать, изменяя content/ , content/_layouts/ и content/_scss/ Directory. Сайт будет жить перезагрузкой, когда вы сохраняете изменения, которые вы изменяете.
См. Сопутствующий код для получения дополнительной информации о разработке.
Если вы хотите внести свой вклад и улучшить наш веб -сайт, пожалуйста, поработайте над вилкой или филиалом. Только работающие и проверенные изменения будут объединены в Master. Используйте систему проблем для поддержки и одобрения разработчиков в ваших изменениях.
Документация для /documentation автоматически извлечена из репозитория Flixel-Docs (через сценарий Package.json preinstall , который запускает Scripts /Install-Flixel-Docs-repo.js).
Пожалуйста, просмотрите Readme в репо Flixel-Docs для получения дополнительной информации об обновлении страниц haxeflixel.com/documentation.
Создайте .md -файл в /content/demos после этого примера:
```
---
title: "Demo-Name"
layout: demo
width: 800
height: 500
source: "flixel-demos-subdirectory/Demo-Name"
---
Here goes the actual description of the demo in GitHub-Flavored-Markdown:
* What the demo displays
* Who created it
* What the controls are
* etc
HTML is still allowed and can be used for more advanced descriptions.
```
source указывает на подкаталог Flixel-Demos, который содержит демонстрацию.
width и height по умолчанию до 640 и 480 и должны быть опущены в этом случае.
Demo-Name.png to /static/demos/images ..md -файл в /content/showcase после этого примера: ---
layout: showcase
title: "Go! Go! PogoGirl"
itch: https://ohsat-andrej.itch.io/go-go-pogogirl
website: https://www.ohsat.com/game/go-go-pogogirl/
steam: https://store.steampowered.com/app/1681010/Go_Go_PogoGirl/
switch: https://www.nintendo.com/store/products/go-go-pogogirl-switch/
ps4: https://store.playstation.com/en-us/product/UP0891-PPSA10169_00-GOGOPOGOGIRLRATG
xbox: https://www.microsoft.com/store/productid/9P10H7L6QCCJ
date: "2022-02-01"
---
Dates should use YYYY-MM-DD
Note that by adding a URL to one of the supported targets, the icon will automatically become coloured on the
[showcase page](https://haxeflixel.com/showcase) and link to that URL.
*.md , например, Go! Go! PogoGirl.png to /static/images/showcase . Они изменяются и обрезаны до 500x260, поэтому лучше использовать то же соотношение.Витрины, которые официально не опубликованы, еще не принимаются только в особых случаях. То же самое верно для игр из игровых джемов.
Наряду с установленными и запущенными командами (см. О о), существуют другие полезные команды / рабочие процессы.
Все, что вам нужно, должно быть установлено с помощью npm install . Используя VSCODE, вы также можете установить рекомендуемые расширения для автоматического форматирования (в файле сохранить). Однако все рабочие процессы должны быть полностью полезны через CLI.
content/_static Все статические файлы (обычно / в основном изображения) копируются в корневой каталог сайта с информацией о каталоге, хранящейся в том, что в такт. Таким образом, content/_static/images/ будет обращаться в out/images , и их следует ссылаться с сайта с помощью Just /images/ .
npm run start Запуск npm run start запустит множество участков и Sass .Scss и перезагрузит изменения.
npm test Запуск npm test будет выполнять тестирование форматирования и линии для проекта. Вы можете просто запустить npm test если хотите запустить все тесты ( test:js , test:liquid и test:prettier ).
Однако вы можете альтернативно запускать каждый тест по отдельности.
npm run test:js проверит JavaScript через стандарт. Чтобы автоматически исправить все, вы можете запустить npm run NPM запустить исправление: JS
npm run test:liquid проверит, будет ли сайт построить через eleventy --dryrun .
npm run test:prettier проверит общую консистенцию стиля с помощью красителя. Вы можете запустить npm run fix:prettier как простой способ исправить несоответствия.
npm fix Запуск npm fix будет выполнять автоматическое форматирование в код, чтобы сопоставить его со standardjs , .liquidrc и .prettierrc.yaml . Обычно вы захотите запустить, прежде чем отправить PR!