code cookbook

Livro de receitas de código Haxe

Fontes para o site de livros de receitas do Haxe Code, um site de recursos orientado pela comunidade para aprender Haxe na prática.

O repositório contém um gerador de sites estáticos, que converte artigos de remarcar em um site. O projeto está sendo desenvolvido aqui no Github, sinta -se à vontade para contribuir com trechos e tutoriais de código relacionados à Haxe.

Estrutura

• Os artigos reais estão em ativos/conteúdo/livro de receitas, organizado por pasta.
• Os arquivos de modelo HTML estão em ativos/conteúdo/.
• Os arquivos estáticos (arquivos CSS, JS, Imagens) estão em ativos/inclui/.
• Os arquivos de origem Haxe do gerador estão no SRC/.
• O conteúdo gerado pelo site será lançado em output/ (excluído do Git).

Contribuindo

Mudanças contribuindo

Para contribuir com uma mudança, você deve fazer uma solicitação de tração. Isso pode ser feito usando o site do GitHub ou bifurcação/clonando o projeto.

Contribuindo usando o GitHub como editor online

Esta é a maneira mais fácil de fazer pequenas mudanças:

• Navegue para um artigo em https://code.haxe.org e pressione o botão Editar em qualquer página:
• Você é redirecionado para o Github. Depois de ter uma conta e estar conectado, você pode fazer a alteração no editor online.
• Defina a descrição / o que você mudou e pressione o botão Alterar a solicitação :
• Uma solicitação de tração será criada. O Github faz um garfo para você automaticamente.

Contribuindo usando um garfo

Isso também permitiria testar/ver as alterações antes de enviar o que também é útil quando você deseja adicionar novas páginas.

• Faça um garfo (no Github) do projeto.
• Confira seu repositório em sua máquina, crie uma nova ramificação para a solicitação de tração.
• Faça as alterações nesse novo ramo.
• Empurre os compromissos (eles vão para o garfo).
• No Github, você faz uma solicitação de tração da filial do seu garfo para o repositório original.

Criando artigos

Adicione/edite os artigos (arquivos de marcação) na pasta Ativo e faça uma solicitação de tração. O escopo do livro de receitas inclui o idioma principal, a biblioteca padrão e também qualquer biblioteca mantida pela Fundação Haxe.

Formatação

Seria bom se você mantivesse a formatação do código no mesmo estilo que já usado:

• Aparelho na mesma linha.
• Indentação de dois espaço.
• Nenhuma indicação para variáveis ​​locais e retorno de funções, a menos que seja instrutiva.
• Tipo não dicas para campos.
• Tipo não para argumentos de função, a menos que seja muito óbvio.
• Uso criterioso de quebras de linha extras para evitar quebras automáticas feias (verifique a saída).

Outras observações

• O primeiro título é usado na navegação. Mantenha este título curto.
• O primeiro parágrafo é usado como descrição. Descreva o que trata o conteúdo do artigo.
• Use > Author: [Name](https://github.com/username) para se marcar como autor do artigo. Os outros colaboradores são deduzidos do Git Commits.
• Tag o artigo usando [tags]: / "tag1,tag2" (sem espaços). Tente usar uma tag existente.
• Mencione o autor / fontes na parte inferior da página.
• Se você deseja incluir um snippet de código try.haxe.org use [tryhaxe](https://try.haxe.org/embed/76f24) .
• Se você deseja incluir um uso de vídeo do YouTube [youtube](https://www.youtube.com/watch?v=dQw4w9WgXcQ) .
• Se possível, vincule -se a páginas relacionadas na documentação do manual Haxe / API.
• Se você deseja usar imagens ou outras inclui, crie uma pasta chamada ativos no mesmo diretório do artigo e link para isso.

Este seria um modelo típico a ser usado. Use ```haxe para destaque da sintaxe:

 [Tags]: / "Classe, Array, JSON, campos de construção"

# Título da página

Descrição e explicação do código.

## implementação
`` `Haxe
classe principal {
  // código aqui
}
`` `

## Uso

Descrição de como usar/testar o código.

`` `Haxe
Teste de classe {
  // código aqui
}
`` `

> Mais sobre este tópico: 
> 
> * [Campo de classe no manual Haxe] (https://haxe.org/manual/class-field.html)
> 
> Autor: [Nome] (https://github.com/username)

Executando uma cópia local

Para executar o projeto, você pode usar o Neko:

Ligue para neko CodeCookBook.n para re-gerar os arquivos de saída.

Contribuindo para o gerador

Você precisa do Haxe 3.4.2+ instalado.

A fonte do gerador de sites estáticos depende do HXTEMPLO e do Haxe-Markdown.

Instale as bibliotecas usando o Haxelib, execute o seguinte comando na raiz do projeto:

 haxelib install all

Os arquivos CSS são compactados usando menos. Instale a partir do NPM:

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