code cookbook

КОДЕСКА КОДА КОДА

Источники для поваренной книги Haxe Code, веб -сайта ресурсов, управляемого сообществом для обучения Haxe на практике.

Репозиторий содержит статический генератор веб -сайтов, который преобразует статьи Markdown в веб -сайт. Проект разрабатывается здесь, на GitHub, не стесняйтесь вносить вклад в фрагменты кода, связанные с Haxe, и учебные пособия.

Структура

• Фактические статьи находятся в активах/контенте/кулинарной книге, организованной на папку.
• Файлы шаблонов HTML находятся в активах/контенте/.
• Статические файлы (CSS, JS, изображения) файлы находятся в активах/включает/.
• Файлы исходных источников haxe генератора находятся в SRC/.
• Контент, сгенерированный веб-сайтом, будет выводиться в output/ (исключен из GIT).

Внося

Способствуя изменения

Чтобы внести вклад, вы должны сделать запрос на вытягивание. Это может быть сделано с помощью веб -сайта GitHub или путем вилки/клонирования проекта.

Вклад использования GitHub в качестве онлайн -редактора

Это самый простой способ внести небольшие изменения:

• Перейдите к статье на https://code.haxe.org и нажмите кнопку «Редактировать» на любой странице:
• Вы перенаправлены на GitHub. После того, как у вас есть учетная запись и вы входите в систему, вы можете внести изменения в онлайн -редактор.
• Установите описание / что вы изменили, и нажмите кнопку изменения запроса :
• Будет создан запрос на тягу. GitHub делает вилку для вас автоматически.

Вклад с использованием вилки

Это также позволило бы проверить/увидеть изменения перед отправкой, которые также полезны, когда вы хотите добавить новые страницы.

• Сделайте вилку (на GitHub) проекта.
• Ознакомьтесь с вашим репо на своей машине, создайте новую филиал для запроса на вытяжение.
• Внесите изменения в этой новой ветви.
• Нажмите на коммиты (они идут в вашу вилку).
• На GitHub вы делаете запрос на привлечение из филиала вашей вилки в оригинальную репо.

Создание статей

Пожалуйста, добавьте/отредактируйте статьи (файлы разметки) в папку Assets и сделайте запрос на вытяжение. Объем поваренной книги включает в себя основной язык, стандартную библиотеку, а также любые библиотеки, поддерживаемые Фондом Haxe.

Форматирование

Было бы неплохо, если бы вы сохранили форматирование кода в том же стиле, что и уже использованный:

• Брекеты на той же линии.
• Двух пространственно-отступа.
• Никаких типовых подборов для локальных переменных и функций возвращаются, если это не поучительно.
• Типовые подходы для полей.
• Типовые подборы для аргументов функций, если это не очень очевидно.
• Разумное использование дополнительных разрывов линии, чтобы избежать уродливых автоматических перерывов (проверьте выход).

Другие замечания

• Первый заголовок используется в навигации. Держите этот заголовок коротким.
• Первый абзац используется в качестве описания. Опишите, о чем содержится статья.
• Используйте > Author: [Name](https://github.com/username) , чтобы пометить себя автором статьи. Другие участники выводятся из GIT Commits.
• Отметьте статью, используя [tags]: / "tag1,tag2" (без пробелов). Попробуйте использовать существующий тег.
• Упомяните автора / источники внизу страницы.
• Если вы хотите включить фрагмент кода try.haxe.org использование [tryhaxe](https://try.haxe.org/embed/76f24) .
• Если вы хотите включить видео на YouTube [youtube](https://www.youtube.com/watch?v=dQw4w9WgXcQ) .
• Если возможно, свяжитесь с соответствующими страницами в руководстве Haxe / API документации.
• Если вы хотите использовать изображения или другие включающие, создайте папку, называемую активами в том же каталоге, что и статья, и ссылка на это.

Это был бы типичный шаблон для использования. Используйте ```haxe для синтаксиса выделения:

 [TAGS]: / "Class, Array, JSON, поля здания"

# Название страницы

Описание и объяснение кода.

## Выполнение
`` haxe
класс Main {
  // код здесь
}
`` `

## Использование

Описание того, как использовать/проверить код.

`` haxe
Класс Тест {
  // код здесь
}
`` `

> Подробнее по этой теме: 
> 
> * [Поле класса в Haxe Manual] (https://haxe.org/manual/class-field.html)
> 
> Автор: [name] (https://github.com/username)

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

Чтобы запустить проект, вы можете использовать Neko:

Позвоните neko CodeCookBook.n чтобы повторно генерировать выходные файлы.

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

Вам нужен Haxe 3.4.2+.

Статический источник генератора сайтов зависит от Hxtemplo и Haxe-Markdown.

Установите библиотеки, используя Haxelib, запустите следующую команду в корне проекта:

 haxelib install all

Файлы CSS сжимаются с использованием меньше. Установите из NPM:

 npm install -g less
npm install -g less-plugin-clean-css