code cookbook

Libro de cocina de código haxe

Fuentes para el sitio del libro de cocina de código HAXE, un sitio web de recursos dirigido por la comunidad para aprender HAXE en la práctica.

El repositorio contiene un generador de sitios web estático, que convierte los artículos de Markdown en un sitio web. El proyecto se está desarrollando aquí en GitHub, no dude en contribuir con fragmentos y tutoriales de código relacionado con HAXE.

Estructura

• Los artículos reales están en activos/contenido/libro de cocina, organizados por carpeta.
• Los archivos de plantilla HTML están en activos/contenido/.
• Los archivos estáticos (CSS, JS, imágenes) están en activos/Incluye/.
• Los archivos de origen HAXE del generador están en SRC/.
• El contenido generado por el sitio web saldrá en output/ (excluido de GIT).

Que contribuye

Cambios contribuyentes

Para contribuir con un cambio, debe hacer una solicitud de extracción. Esto se puede hacer utilizando el sitio web de GitHub o con la bifurcación/clonación del proyecto.

Contribuyendo con GitHub como editor en línea

Esta es la forma más fácil de hacer pequeños cambios:

• Navegue a un artículo en https://code.haxe.org y presione el botón Editar en cualquier página:
• Estás redirigido a GitHub. Una vez que tenga una cuenta y haya iniciado sesión, puede hacer el cambio en el editor en línea.
• Establezca la descripción / lo que cambió y presione el botón Cambiar de solicitud :
• Se creará una solicitud de extracción. Github hace una bifurcación para usted automáticamente.

Contribuyendo con un bifurcado

Esto también permitiría probar/ver los cambios antes de enviar, lo que también es útil cuando desea agregar nuevas páginas.

• Haga una bifurcación (en GitHub) del proyecto.
• Consulte su repositorio en su máquina, cree una nueva rama para la solicitud de extracción.
• Hacer los cambios en esa nueva rama.
• Empuja los compromisos (van a tu bifurcación).
• En GitHub, realiza una solicitud de extracción de la rama de su horquilla al repositorio original.

Creación de artículos

Agregue/edite los artículos (archivos de markdown) en la carpeta de activos y haga una solicitud de extracción. El alcance del libro de cocina incluye el idioma central, la biblioteca estándar y también cualquier biblioteca mantenida por la Fundación Haxe.

Formato

Sería bueno si mantiene el formato del código en el mismo estilo que ya se usa:

• Aparatos ortopédicos en la misma línea.
• Sangría de dos espacios.
• No hay consejos de tipo para variables locales y retorno de funciones a menos que sea instructivo.
• Tipo de insinuos para campos.
• Tipo de intento para los argumentos de funciones a menos que sea muy obvio.
• Uso juicioso de rupturas de línea adicionales para evitar descansos automáticos feos (verifique la salida).

Otros comentarios

• El primer encabezado se usa en la navegación. Mantenga este título corto.
• El primer párrafo se usa como descripción. Describa de qué se trata el contenido del artículo.
• Use > Author: [Name](https://github.com/username) para marcarlo como autor del artículo. Los otros contribuyentes son inferidos de Git Commits.
• Etiquete el artículo usando [tags]: / "tag1,tag2" (sin espacios). Intenta usar una etiqueta existente.
• Mencione el autor / fuentes en la parte inferior de la página.
• Si desea incluir un fragmento de código try.haxe.org, use [tryhaxe](https://try.haxe.org/embed/76f24) .
• Si desea incluir un video de YouTube, use [youtube](https://www.youtube.com/watch?v=dQw4w9WgXcQ) .
• Si es posible, enlace a páginas relacionadas en la documentación del manual / API de HAXE.
• Si desea usar imágenes u otras incluye, cree una carpeta llamada activos en el mismo directorio que el artículo y el enlace a eso.

Esta sería una plantilla típica para usar. Use ```haxe para resaltar sintaxis:

 [Etiquetas]: / "Clase, Array, JSON, Building-Fields"

# Título de la página

Descripción y explicación del código.

## Implementación
`` `HAXE
clase principal {
  // código aquí
}
`` `` ``

## Uso

Descripción de cómo usar/probar el código.

`` `HAXE
Prueba de clase {
  // código aquí
}
`` `` ``

> Más sobre este tema: 
> 
> * [Campo de clase en el manual haxe] (https://haxe.org/manual/class-field.html)
> 
> Autor: [Nombre] (https://github.com/username)

Ejecutar una copia local

Para ejecutar el proyecto, puede usar Neko:

Llame neko CodeCookBook.n para volver a generar los archivos de salida.

Contribuyendo al generador

Necesita instalado HAXE 3.4.2+.

La fuente del generador de sitios estático depende de Hxtemplo y Haxe-Markdown.

Instale las bibliotecas usando HAXELIB, ejecute el siguiente comando en la raíz del proyecto:

 haxelib install all

Los archivos CSS se comprimen con menos. Instalar desde NPM:

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