haxe.org

haxe.org

Это кодовая база для веб -сайта https://haxe.org.

Вклад в контент

На веб -сайте есть ссылка «внести» на нижнем колонтитуле каждой страницы. Нажатие на эту ссылку перенесет вас в соответствующий файл в этом хранилище или соответствующий файл в хранилище Haxemanual.

Затем вы можете отредактировать, используя онлайн -редактор файлов Github и отправить запрос на вытяжку. Вы также можете расколоть репо и отредактировать на своей локальной машине с помощью предпочтительного текстового редактора, что может быть проще для больших интеграций.

Добавление сообщения в блоге

Добавьте файл с именем YEAR-MONTH-DAY-name.md name.md в posts/ .

Первая часть файла содержит метаданные после:

 title : The title of your post
author : Author id
description : The description of your post
background : Optional image filename used as background for the post header
published : true/false, if true it'll apear in the blog post list/rss feed
tags : Comma separated of tags id
disqusID : Unique id number used for comments, take the number of the last post and increment it by one
---

Идентификатор автора должен быть указан в people.json :

{
  "username" : " the user id used in the post " ,
  "name" : " Your Name " ,
  "bio" : " One line bio about you "
}

Фоновое изображение должно храниться в www/img/blog/backgrounds/ .

Теги должны быть перечислены в posts/tags.json :

{
  "tag" : " the tag id " ,
  "name" : " the tag display name " ,
  "description" : " the tag description, shown on the tag post list "
}

Пост должен иметь --- и пустую линию между метаданными и содержанием.

Содержание сообщения находится в Markdown, но вы можете включить HTML. Если вы делаете, это должно быть действительным XML, поэтому все теги должны быть закрыты: <br /> в порядке, но <br> нет, а у вас нельзя иметь атрибуты без значения: <tag fullscreen="" /> -это нормально, но <tag fullscren /> нет.

Чтобы включить изображение в Markdown : ![Title](name.png) . Изображение должно храниться в www/img/blog/YEAR-MONTH-DAY-name/ .

Проблемы, ошибки и предложения

Если вы найдете ошибку, у вас есть проблема, предложение или хотите внести свой вклад каким -либо другим образом, используйте трекер выпуска GitHub.

Любые ошибки, которые мы попытаемся обратиться быстро. Новый контент или субъективные проблемы (цвета, шрифты, маркетинговые материалы и т. Д.) Будут рассмотрены в каждом конкретном случае.

Если вы дизайнер и хотите помочь освежить внешний вид сайта, пожалуйста, откройте проблему или свяжитесь с [email protected]. Мы бы хотели ваш вклад!

Вклад CSS

В настоящее время CSS для сайта находится в www/css/style.css.

В настоящее время мы используем библиотеку CSS Bootstrap 2.3.2 и библиотеку значков Font Awesome 4.1.0.

Структура

• Содержание страниц находится на pages/ , в HTML или Markdown.
• Сообщения в блоге в posts/ в Markdown, а их изображения находятся в www/img/blog/$name/ .
• Сообщения о выпуске для версий Haxe находятся в releaseNotes/ , в Markdown.
• Код в src/ . Поколения вызовы src/Main.hx и JavaScript src/Client.hx .
• Взгляды находятся в views/ и используют синтаксис шаблона Haxe с отключенным Foreach.
• Статические активы в www/ .

Запуск локальной копии для разработки

Веб -сайт haxe.org был разработан, чтобы его легко генерировать, чтобы запустить локальную копию. Следуйте этим шагам:

Требования

• Хакс
• Haxelib
• Неко
• загрязнение
• Nodejs
• npm

Настройка

• Установите зависимости haxelib install all и npm install в корневом каталоге.
• Обновление субмодуля зависимостей git submodule init && git submodule update .
• Клонировать руководство в manual каталог с git clone https://github.com/HaxeFoundation/HaxeManual.git manual .
• Создайте веб -сайт, запустив haxe generate.hxml .

Веб -сайт теперь доступен в папке out/ OUT, вы можете запустить его с nekotools server -d out и получить доступ к нему по адресу http://localhost:2000/ .

Развертывание обновлений

• Любой толчок или слияние в staging ветвь заставит Github Deciation для построения и развертывания на «staging.haxe.org».
• Любой толчок или слияние в master ветвь вызовет действия GitHub для построения и развертывания в «haxe.org».