minimal

O tema mínimo

Minimal é um tema Jekyll para páginas GitHub. Você pode visualizar o tema para ver como fica ou até mesmo usá-lo hoje.

Uso

Para usar o tema Mínimo:

1. Adicione o seguinte ao _config.yml do seu site:

    remote_theme : pages-themes/[email protected]
   plugins :
   - jekyll-remote-theme # add this line to the plugins list if you already have one

2. Opcionalmente, se desejar visualizar seu site em seu computador, adicione o seguinte ao Gemfile do seu site:

    gem "github-pages" , group : :jekyll_plugins 

Personalização

Variáveis ​​de configuração

Minimal respeitará as seguintes variáveis, se definidas no _config.yml do seu site:

 title : [The title of your site]
description : [A short description of your site's purpose]

Além disso, você pode optar por definir as seguintes variáveis ​​opcionais:

 show_downloads : ["true" or "false" (unquoted) to indicate whether to provide a download URL]
google_analytics : [Your Google Analytics tracking ID]

Folha de estilo

Se você quiser adicionar seus próprios estilos personalizados:

1. Crie um arquivo chamado /assets/css/style.scss em seu site
2. Adicione o seguinte conteúdo ao topo do arquivo, exatamente como mostrado:

   ---
   ---
   
   @import " {{ site.theme }} " ;

3. Adicione qualquer CSS personalizado (ou Sass, incluindo importações) que desejar imediatamente após a linha @import

Nota: Se desejar alterar as variáveis ​​Sass do tema, você deve definir novos valores antes da linha @import em sua folha de estilo.

Layouts

Se desejar alterar o layout HTML do tema:

1. Para algumas alterações, como um favicon personalizado, você pode adicionar arquivos personalizados na pasta _includes local. Os arquivos fornecidos com o tema fornecem um ponto de partida e são incluídos no modelo de layout original.
2. Para alterações mais extensas, copie o modelo original do repositório do tema
   ( Dica profissional: clique em "bruto" para facilitar a cópia )
3. Crie um arquivo chamado /_layouts/default.html em seu site
4. Cole o conteúdo do layout padrão copiado na primeira etapa
5. Personalize o layout como desejar

Personalizando o código do Google Analytics

O Google lançou várias iterações em seu código do Google Analytics ao longo dos anos, desde que este tema foi criado. Se quiser aproveitar as vantagens do código mais recente, cole-o em _includes/head-custom-google-analytics.html em seu site Jekyll.

Substituindo URLs gerados pelo GitHub

Os modelos geralmente dependem de URLs fornecidos pelo GitHub, como links para seu repositório ou links para baixar seu projeto. Se desejar substituir um ou mais URLs padrão:

1. Consulte a fonte do modelo para determinar o nome da variável. Será no formato {{ site.github.zip_url }} .
2. Especifique o URL que você deseja que o modelo use no _config.yml do seu site. Por exemplo, se a variável fosse site.github.url , você adicionaria o seguinte:

    github :
     zip_url : http://example.com/download.zip
     another_url : another value

3. Quando seu site for construído, Jekyll usará o URL que você especificou, em vez do URL padrão fornecido pelo GitHub.

Nota: Você deve remover o site. prefixo, e cada nome de variável (após github. ) deve ser recuado com dois espaços abaixo de github: .

Para obter mais informações, consulte a documentação das variáveis ​​do Jekyll.

Roteiro

Consulte os problemas em aberto para obter uma lista dos recursos propostos (e dos problemas conhecidos).

Filosofia do projeto

O tema Minimal tem como objetivo tornar rápido e fácil para os usuários do GitHub Pages a criação de seu primeiro (ou centésimo) site. O tema deve atender imediatamente à grande maioria das necessidades dos usuários, optando pela simplicidade em vez da flexibilidade, e fornecer aos usuários a oportunidade de optar por complexidade adicional se tiverem necessidades específicas ou desejarem personalizar ainda mais sua experiência. (como adicionar CSS personalizado ou modificar o layout padrão). Também deve ficar ótimo, mas nem é preciso dizer.

Contribuindo

Interessado em contribuir para o Minimal? Adoraríamos sua ajuda. Minimal é um projeto de código aberto, criado com uma contribuição de cada vez por usuários como você. Consulte o arquivo CONTRIBUTING para obter instruções sobre como contribuir.

Visualizando o tema localmente

Se desejar visualizar o tema localmente (por exemplo, no processo de propor uma alteração):

1. Clone o repositório do tema ( git clone https://github.com/pages-themes/minimal )
2. cd no diretório do tema
3. Execute script/bootstrap para instalar as dependências necessárias
4. Execute bundle exec jekyll serve para iniciar o servidor de visualização
5. Visite localhost:4000 em seu navegador para visualizar o tema

Executando testes

O tema contém um conjunto mínimo de testes, para garantir que um site com o tema seja construído com sucesso. Para executar os testes, basta executar script/cibuild . Você precisará executar script/bootstrap uma vez antes que o script de teste funcione.