milou

? Milou, um gerador de kit de imprensa estático

Milou é um gerador de sites estáticos que ajuda você a criar kits de imprensa bonitos e informativos para apresentar sua empresa e seus produtos à imprensa. Ele permite que você apresente a história da sua marca, comunicados à imprensa, ativos de mídia e principais membros da equipe de maneira estruturada e envolvente.

Características

• Geração de site estático : Milou gera arquivos HTML estáticos, com carregamento rápido, acessibilidade por padrão e design responsivo
• Configuração YAML : formato de configuração simples e legível por humanos
• Modelos padronizados : deixe Milou fornecer uma configuração de modelo e preencher os espaços em branco com seu conteúdo

Vitrine

• Kit de imprensa do Dice'n Goblins

Começando

Instalação

Você precisará de um terminal e Node.js.

Instale Milou usando npm:

npm install -g milou

Empresa

Crie um novo diretório contendo os dados da sua empresa:

mkdir mypresskit
cd mypresskit
milou new

O diretório raiz do seu projeto contém os dados da sua empresa. Você deverá apresentar sua empresa preenchendo o arquivo data.yml gerado neste diretório. Você pode usar este exemplo de arquivo data.yml da empresa preenchido como referência.

Você deve colocar as imagens da sua empresa na subpasta de images . Imagens denominadas header.* (por exemplo, header.png ou header.jpg ) serão usadas no cabeçalho da página. Arquivos prefixados por logo (por exemplo, logo01.png ou logo.jpg ) serão colocados na seção de logotipos da sua página. Qualquer outra imagem nesta pasta será incluída como imagem no press kit gerado.

Para incluir um arquivo CSS personalizado, crie um arquivo chamado style.css na pasta da sua empresa. Ele será incluído automaticamente em todas as páginas.

Produto

Crie um novo subdiretório contendo um produto:

mkdir myproduct
cd mypresskit
milou new -t product

As pastas de produtos conterão dados de seu software, jogos ou qualquer outro tipo de produto. Assim como para empresas, escreva seu conteúdo no arquivo data.yml gerado neste diretório. Você pode usar este arquivo de exemplo como referência.

As imagens também devem ser incluídas na nova subpasta de images .

Construir

Seu projeto agora deve ficar assim:

 ? data.yml
 images/
  ? header.png
  ? logo.png
 myproduct/
  ? data.yml
   images/
    ? header.png
    ? logo.png
    ? screenshot1.png
    ? screenshot2.png

No diretório raiz do seu projeto, agora você pode construir seu site estático:

 milou build .

Isso produzirá HTML, CSS e imagens estáticos na pasta build . Agora você pode iniciar um servidor web para servir seu conteúdo:

 cd build
npx serve

Carregue esta pasta em qualquer host de site estático (páginas GitHub, Netlify, páginas CloudFlare, etc...) para tornar seu kit de imprensa acessível para todo o mundo.

Referência de linha de comando

 milou new [options] <destination>

Create an empty `data.yml` file and its `images/` folder in the <destination> folder (current working directory by default).

  There are two template types available: company (default) or product.

Options:
  -V, --version         output the version number
  -t, --type [company]  set the type of the new `data.yml` file (default: "company")
  -h, --help            display help for command

 milou build [options] <entry point>

Generate a press kit based on information found in `data.yml` files.

Options:
  -V, --version               output the version number
  -o, --output [destination]  output the build folder to the [destination] (defaults to ./build) (default: "/Users/alicegg/Code/mypresskit/myproduct/build")
  -w, --watch                 watch project for changes and re-generate if needed
  -p, --port [8080]           set the server port to [8080] (default: 8080)
  -D, --clean-build-folder    delete the build folder beforehand
  -T, --ignore-thumbnails     use original images in galleries instead of thumbnails (will increase pages size)
  -h, --help                  display help for command

Créditos

Pixelnest/presskit.html

Milou foi bifurcado de presskit.html, feito por Pixelnest Studio.

kit de imprensa()

Presskit.html foi inspirado em presskit(), feito por Rami Ismail.