jekyll theme basically basic
1.4.5 - 2021-07-05
Basicamente Basic é um tema Jekyll que pretende substituir o Minima padrão, com algumas melhorias incluídas para garantir:
Se você estiver executando o Jekyll v3.5+ e auto-hospedado, poderá instalar rapidamente o tema como uma jóia Ruby. Se você estiver hospedando com GitHub Pages, poderá instalar como um tema remoto ou copiar diretamente todos os arquivos do tema (veja a estrutura abaixo) em seu projeto.
Adicione esta linha ao Gemfile do seu site Jekyll:
gem "jekyll-theme-basically-basic" Adicione esta linha ao arquivo _config.yml do seu site Jekyll:
theme : jekyll-theme-basically-basicEm seguida, execute o Bundler para instalar a gem do tema e as dependências:
bundle install
GitHub Pages adicionou suporte completo para qualquer tema hospedado no GitHub.
Substitua gem "jekyll" por:
gem "github-pages" , group : :jekyll_plugins Execute bundle update e verifique se todas as gemas foram instaladas corretamente.
Adicione remote_theme: "mmistakes/[email protected]" ao seu arquivo _config.yml . Remova qualquer outra entrada theme: ou remote_theme:
Observação: seu site Jekyll deve estar visível imediatamente em http://USERNAME.github.io. Caso contrário, você pode forçar uma reconstrução personalizando seu site (veja abaixo para mais detalhes).
Se você estiver hospedando vários sites baseados em Jekyll com o mesmo nome de usuário do GitHub, você terá que usar páginas de projeto em vez de páginas de usuário. Essencialmente, você renomeia o repositório para algo diferente de USERNAME.github.io e cria uma ramificação gh-pages de master . Para obter mais detalhes sobre como configurar as coisas, verifique a documentação do GitHub.
Se você bifurcou ou baixou o repositório jekyll-theme-basically-basic poderá remover com segurança os seguintes arquivos e pastas:
.editorconfig.gitattributes.github.scss-lint.ymlCHANGELOG.mdjekyll-theme-basically-basic.gemspecLICENSERakefileREADME.mdscreenshot.png/docs/exampleSe você estiver usando o Ruby Gem ou versões de tema remoto do Basicamente Basic, a atualização será bastante fácil.
Para verificar qual versão você está usando atualmente, visualize a fonte do seu site construído e você deverá fazer algo semelhante a:
<!--
Basically Basic Jekyll Theme 1.4.5
Copyright 2017-2018 Michael Rose - mademistakes.com | @mmistakes
Free for personal and commercial use under the MIT license
https://github.com/mmistakes/jekyll-basically-theme/blob/master/LICENSE
-->
No topo de cada arquivo .html , /assets/css/main.css e /assets/js/main.js .
Simplesmente execute bundle update se você estiver usando Bundler (tem um Gemfile ) ou gem update jekyll-theme-basically-basic se não estiver.
Verifique se você tem a versão mais recente atribuída em _config.yml
remote_theme: "mmistakes/[email protected]"
Nota: Se @xxx for omitido, o branch master atual do tema será usado. É aconselhável "bloquear" remote_theme em uma versão específica para evitar a introdução de alterações significativas em seu site.
A próxima etapa requer a reconstrução do site GitHub Pages para que ele possa obter as atualizações mais recentes do tema. Isso pode ser conseguido enviando um commit para seu repositório GitHub.
Um commit vazio também fará o trabalho se você não tiver nada para enviar no momento:
git commit --allow-empty -m "Force rebuild of site"
Se quiser aproveitar ao máximo o fluxo de trabalho do Jekyll + GitHub Pages, você precisará utilizar o Git. Para baixar atualizações de tema, você deve primeiro garantir que haja um controle remoto upstream. Se você bifurcou o repositório do tema, provavelmente está pronto para prosseguir.
Para verificar novamente, execute git remote -v e verifique se você pode buscar na origin https://github.com/mmistakes/jekyll-theme-basically-basic.git .
Para adicioná-lo você pode fazer o seguinte:
git remote add upstream https://github.com/mmistakes/jekyll-theme-basically-basic.git
Agora você pode extrair quaisquer commits feitos no branch master do tema com:
git pull upstream master
Dependendo da quantidade de personalizações feitas após a bifurcação, é provável que haja conflitos de mesclagem. Trabalhe com quaisquer sinalizadores Git de arquivos conflitantes, preparando as alterações que deseja manter e, em seguida, confirme-as.
Outra maneira de lidar com atualizações é baixar o tema – substituindo manualmente seus layouts, inclusões e ativos pelos mais novos. Para ter certeza de que você não perderá nenhuma alteração, provavelmente é uma boa ideia revisar o histórico de commits do tema para ver o que mudou desde então.
Aqui está uma lista de verificação rápida das pastas/arquivos importantes que você deve ter em mente:
| Nome | |
|---|---|
_layouts | Substitua tudo. Aplique edições se você personalizou algum layout. |
_includes | Substitua tudo. Aplique edições se você personalizou alguma inclusão. |
assets | Substitua tudo. Aplique edições se você personalizou folhas de estilo ou scripts. |
_sass | Substitua tudo. Aplique edições se você personalizou parciais do Sass. |
_data/theme.yml | Seguro para manter. Verifique se não houve grandes alterações ou acréscimos estruturais. |
_config.yml | Seguro para manter. Verifique se não houve grandes alterações ou acréscimos estruturais. |
Observação: se você não estiver vendo a versão mais recente, limpe os caches do navegador e do CDN. Dependendo do seu ambiente de hospedagem, versões mais antigas de /assets/css/main.css , /assets/js/main.js ou *.html podem ser armazenadas em cache.
Layouts, inclusões, parciais Sass e arquivos de dados são todos colocados em seus locais padrão. Folhas de estilo e scripts em assets e alguns arquivos relacionados ao desenvolvimento no diretório raiz do projeto.
Observação: se você instalou o Basicamente Basic por meio do método Ruby Gem, os arquivos de tema encontrados em /_layouts , /_includes , /_sass e /assets estarão faltando. Isso é normal, pois eles vêm com a joia jekyll-theme-basically-basic .
jekyll-theme-basically-basic
├── _data # data files
| └── theme.yml # theme settings and custom text
├── _includes # theme includes and SVG icons
├── _layouts # theme layouts (see below for details)
├── _sass # Sass partials
├── assets
| ├── javascripts
| | └── main.js
| └── stylesheets
| └── main.scss
├── _config.yml # sample configuration
└── index.md # sample home page (all posts/not paginated)
Após criar um Gemfile e instalar o tema você precisará adicionar e editar os seguintes arquivos:
_config.yml/_data/theme.ymlindex.mdNota: Consulte a documentação de paginação abaixo para obter instruções sobre como habilitá-la para a página inicial.
jekyll new Usar o comando jekyll new irá colocá-lo em funcionamento o mais rápido possível.
Edite _config.yml e crie _data/theme.yml conforme as instruções acima e pronto.
A configuração dos elementos de todo o site ( lang , title , description , logo , author , etc.) acontece no _config.yml do seu projeto. Consulte o exemplo de configuração neste repositório para referência adicional.
| Descrição | |
|---|---|
lang | Usado para indicar o idioma do texto (por exemplo, en-US, en-GB, fr) |
title | O título do seu site (por exemplo, Site incrível de Dungan) |
description | Breve descrição do site (por exemplo, um blog sobre purê de gafanhoto) |
url | O URL completo do seu site (por exemplo, https://groverloaf.org) |
author | Informações globais do autor (veja abaixo) |
logo | Caminho para um logotipo em todo o site ~100x100px (por exemplo, /assets/your-company-logo.png) |
twitter_username | Nome de usuário do Twitter para todo o site, usado como link na barra lateral |
github_username | Nome de usuário do GitHub para todo o site, usado como um link na barra lateral |
Para obter mais opções de configuração, consulte a documentação de: jekyll-seo-tag , jekyll-feed , jekyll-paginate e jekyll-sitemap .
Este tema vem em seis skins diferentes (variações de cores). Para alterar as skins, adicione um dos seguintes ao seu arquivo /_data/theme.yml :
skin: default | skin: night | skin: plum |
|---|---|---|
skin: sea | skin: soft | skin: steel |
|---|---|---|
Este tema permite que você use facilmente o Google Fonts em todo o tema. Basta adicionar o seguinte ao seu /_data/theme.yml , substituindo o name da fonte e weights de acordo.
google_fonts :
- name : " Fira Sans "
weights : " 400,400i,600,600i "
- name : " Fira Sans Condensed " Para alterar o texto encontrado em todo o tema, adicione o seguinte ao seu arquivo /_data/theme.yml e personalize conforme necessário.
t :
skip_links : " Skip links "
skip_primary_nav : " Skip to primary navigation "
skip_content : " Skip to content "
skip_footer : " Skip to footer "
menu : " Menu "
search : " Search "
site_search : " Site Search "
results_found : " Result(s) found "
search_placeholder_text : " Enter your search term... "
home : " Home "
newer : " Newer "
older : " Older "
email : " Email "
subscribe : " Subscribe "
read_more : " Read More "
posts : " Posts "
page : " Page "
of : " of "
min_read : " min read "
present : " Present "
cv_awards : " Awards "
cv_summary_contact : " Contact "
cv_summary_contact_email : " Email "
cv_summary_contact_phone : " Phone "
cv_summary_contact_website : " Website "
cv_location : " Location "
cv_education : " Education "
cv_education_courses : " Courses "
cv_interests : " Interests "
cv_languages : " Languages "
cv_publications : " Publications "
cv_references : " References "
cv_skills : " Skills "
cv_volunteer : " Volunteer "
cv_work : " Work " Por padrão, todas as páginas internas com title serão adicionadas ao menu "fora da tela". Para controle e classificação mais granulares desses links de menu:
Crie uma lista personalizada para substituir a configuração padrão adicionando uma matriz navigation_pages ao seu arquivo /_data/theme.yml .
Adicione caminhos de página brutos na ordem que desejar:
navigation_pages :
- about.md
- cv.md O título e URL de cada link de menu serão preenchidos com base em seu title e permalink , respectivamente.
Divida a lista principal de postagens em listas menores e exiba-as em várias páginas ativando a paginação.
Inclua o plugin jekyll-paginate em seu Gemfile .
group :jekyll_plugins do
gem "jekyll-paginate"
end Adicione jekyll-paginate ao array gems em seu arquivo _config.yml e as seguintes configurações de paginação:
paginate : 5 # amount of posts to show per page
paginate_path : /page:num/ Crie index.html (ou renomeie index.md ) na raiz do seu projeto e adicione o seguinte tema inicial:
layout : home
paginate : true Para ativar a pesquisa em todo o site, adicione search: true ao seu _config.yml .
A pesquisa padrão usa Lunr para construir um índice de pesquisa de todos os seus documentos. Este método é 100% compatível com sites hospedados em GitHub Pages.
Observação: apenas as primeiras 50 palavras de uma postagem ou do conteúdo do corpo da página são adicionadas ao índice de pesquisa do Lunr. Definir search_full_content como true em seu _config.yml substituirá isso e poderá afetar o desempenho de carregamento da página.
Para uma pesquisa mais rápida e relevante (veja a demonstração):
Adicione a gem jekyll-algolia ao seu Gemfile , na seção :jekyll_plugins .
group :jekyll_plugins do
gem "jekyll-feed"
gem "jekyll-seo-tag"
gem "jekyll-sitemap"
gem "jekyll-paginate"
gem "jekyll-algolia"
end Feito isso, baixe todas as dependências executando bundle install .
Mude os provedores de pesquisa de lunr para algolia em seu arquivo _config.yml :
search_provider : algolia Adicione as seguintes credenciais Algolia ao seu arquivo _config.yml . Se você não possui uma conta Algolia, pode abrir um plano comunitário gratuito. Uma vez conectado, você pode obter suas credenciais no painel.
algolia :
application_id : # YOUR_APPLICATION_ID
index_name : # YOUR_INDEX_NAME
search_only_api_key : # YOUR_SEARCH_ONLY_API_KEY
powered_by : # true (default), falseDepois que suas credenciais estiverem configuradas, você poderá executar a indexação com o seguinte comando:
ALGOLIA_API_KEY=your_admin_api_key bundle exec jekyll algolia
Para usuários do Windows, você terá que usar set para atribuir a variável de ambiente ALGOLIA_API_KEY .
set ALGOLIA_API_KEY=your_admin_api_key
bundle exec jekyll algolia
Observe que ALGOLIA_API_KEY deve ser definido como sua chave API de administrador.
Para usar a pesquisa Algolia com sites hospedados em GitHub Pages, siga este guia de implantação. Ou este guia para implantação no Netlify.
Nota: O plugin Jekyll Algolia pode ser configurado de diversas maneiras. Certifique-se de verificar a documentação completa sobre como excluir arquivos e outras configurações valiosas.
As informações do autor são usadas como metadados para postagem "por linhas" e propagam o campo creator dos cartões de resumo do Twitter com o seguinte assunto em _config.yml :
author :
name : John Doe
twitter : johndoetwitter
picture : /assets/images/johndoe.pngAs informações do autor em todo o site podem ser substituídas no cabeçalho de um documento da mesma maneira:
author :
name : Jane Doe
twitter : janedoetwitter
picture : /assets/images/janedoe.png Ou especificando uma chave correspondente no cabeçalho do documento, que existe em site.data.authors . Por exemplo, você tem o seguinte no cabeçalho do documento:
author : megaman E você tem o seguinte em _data/authors.yml :
megaman :
name : Mega Man
twitter : megamantwitter
picture : /assets/images/megaman.png
drlight :
name : Dr. Light
twitter : drlighttwitter
picture : /assets/images/drlight.png Atualmente author.picture é usado apenas em layout: about . O tamanho recomendado é 300 x 300 pixels.
Para ativar a contagem do tempo de leitura, adicione read_time: true ao YAML Front Matter de uma postagem ou página.
Opcionalmente, se você tiver uma conta Disqus, poderá mostrar uma seção de comentários abaixo de cada postagem.
Para habilitar comentários do Disqus, adicione seu nome abreviado do Disqus ao arquivo _config.yml do seu projeto:
disqus :
shortname : my_disqus_shortname Os comentários são habilitados por padrão e só aparecerão na produção quando criados com o seguinte valor de ambiente: JEKYLL_ENV=production
Se você não quiser exibir comentários para uma postagem específica, você pode desativá-los adicionando comments: false ao assunto inicial dessa postagem.
Para ativar o Google Analytics, adicione seu ID de rastreamento a _config.yml assim:
google_analytics : UA-NNNNNNNN-N Semelhante aos comentários, o script de acompanhamento do Google Analytics só aparecerá na produção ao usar o seguinte valor de ambiente: JEKYLL_ENV=production .
Por padrão, a linha de direitos autorais no rodapé exibe o ano atual (no momento da construção) seguido do título do seu site. por exemplo, © 2018 Basically Basic.
Se você quiser alterar isso, adicione copyright ao seu arquivo _config.yml com o texto apropriado:
copyright : " My custom copyright. " Este tema fornece os seguintes layouts, que você pode usar definindo o layout Front Matter em cada página, assim:
---
layout : name
---layout: default Este layout lida com toda a estrutura básica da página, colocando o conteúdo da página entre os elementos do cabeçalho e do rodapé. Todos os outros layouts herdam este e fornecem estilos e recursos adicionais dentro do bloco {{ content }} .
layout: postEste layout acomoda o seguinte assunto inicial:
# optional alternate title to replace page.title at the top of the page
alt_title : " Basically Basic "
# optional sub-title below the page title
sub_title : " The name says it all "
# optional intro text below titles, Markdown allowed
introduction : |
Basically Basic is a Jekyll theme meant to be a substitute for the default --- [Minima](https://github.com/jekyll/minima). Conventions and features found in Minima are fully supported by **Basically Basic**.
# optional call to action links
actions :
- label : " Learn More "
icon : github # references name of svg icon, see full list below
url : " http://url-goes-here.com "
- label : " Download "
icon : download # references name of svg icon, see full list below
url : " http://url-goes-here.com "
image : # URL to a hero image associated with the post (e.g., /assets/page-pic.jpg)
# post specific author data if different from what is set in _config.yml
author :
name : John Doe
twitter : johndoetwitter
comments : false # disable comments on this postNota: As imagens principais podem ser sobrepostas com uma cor de "acento" transparente para unificá-las com a paleta do tema. Para habilitar, personalize o CSS com a seguinte substituição de variável Sass:
$intro-image-color-overlay : true;layout: page Visualmente, esse layout parece e funciona da mesma forma que layout: post , com duas pequenas diferenças.
layout: home Este layout acomoda o mesmo tema inicial do layout: page , com a adição do seguinte:
paginate : true # enables pagination loop, see section above for additional setup
entries_layout : # list (default), grid Por padrão, as postagens são mostradas em uma visualização de lista. Para mudar para uma visualização em grade, adicione entries_layout: grid ao cabeçalho da página.
layout: posts Este layout exibe todas as postagens agrupadas por ano em que foram publicadas. Ele acomoda o mesmo tema inicial do layout: page .
Por padrão, as postagens são mostradas em uma visualização de lista. Para mudar para uma visualização em grade, adicione entries_layout: grid ao cabeçalho da página.
layout: categories Este layout exibe todas as postagens agrupadas por categoria. Ele acomoda o mesmo tema inicial do layout: page .
Por padrão, as postagens são mostradas em uma visualização de lista. Para mudar para uma visualização em grade, adicione entries_layout: grid ao cabeçalho da página.
layout: tags Este layout exibe todas as postagens agrupadas por tag. Ele acomoda o mesmo tema inicial do layout: page .
Por padrão, as postagens são mostradas em uma visualização de lista. Para mudar para uma visualização em grade, adicione entries_layout: grid ao cabeçalho da página.
layout: collection Este layout exibe todos os documentos agrupados por uma coleção específica. Ele acomoda o mesmo front mate que layout: page com a adição do seguinte:
collection : # collection name
entries_layout : # list (default), grid
show_excerpts : # true (default), false
sort_by : # date (default) title
sort_order : # forward (default), reverse Para criar uma página mostrando todos os documentos da coleção recipes , você criaria recipes.md na raiz do seu projeto e adicionaria este assunto inicial:
title : Recipes
layout : collection
permalink : /recipes/
collection : recipes Por padrão, os documentos são mostrados em uma exibição de lista. Para mudar para uma visualização em grade, adicione entries_layout: grid ao cabeçalho da página. Se você quiser classificar a coleção por título, adicione sort_by: title . Se você quiser classificação reversa, adicione sort_order: reverse .
layout: category Este layout exibe todas as postagens agrupadas por uma categoria específica. Ele acomoda o mesmo front mate que layout: page com a adição do seguinte:
taxonomy : # category name
entries_layout : # list (default), grid Por padrão, as postagens são mostradas em uma visualização de lista. Para mudar para uma visualização em grade, adicione entries_layout: grid ao cabeçalho da página.
Para criar uma página mostrando todos os posts atribuídos à categoria foo você criaria foo.md na raiz do seu projeto e adicionaria este assunto inicial:
title : Foo
layout : category
permalink : /categories/foo/
taxonomy : foolayout: tag Este layout exibe todas as postagens agrupadas por uma tag específica. Ele acomoda o mesmo front mate que layout: page com a adição do seguinte:
taxonomy : # tag name
entries_layout : # list (default), grid Por padrão, as postagens são mostradas em uma visualização de lista. Para mudar para uma visualização em grade, adicione entries_layout: grid ao cabeçalho da página.
Para criar uma página mostrando todas as postagens atribuídas à tag foo bar você criaria foo-bar.md na raiz do seu projeto e adicionaria este assunto inicial:
title : Foo Bar
layout : tag
permalink : /tags/foo-bar/
taxonomy : foo barlayout: about Este layout acomoda o mesmo tema inicial do layout: page , com a adição do seguinte para exibir uma imagem do autor:
author :
name : John Doe
picture : /assets/images/johndoe.png O tamanho picture recomendado é de aproximadamente 300 x 300 pixels. Se o objeto author não for definido explicitamente no assunto inicial da página sobre, o tema será padronizado para o valor definido em _config.yml .
Se estiver em branco, nenhuma imagem aparecerá.
layout: cv Este layout acomoda o mesmo tema inicial do layout: page . Ele aproveita um padrão de arquivo baseado em JSON para dados de currículo para renderizar convenientemente um curriculum vitae ou retomar sem problemas.
Basta usar o construtor de currículo no navegador do JSON Resume para exportar um arquivo JSON e salvá-lo em seu projeto como _data/cv.json .
Os tamanhos de imagem sugeridos em pixels são os seguintes:
| Imagem | Descrição | Tamanho |
|---|---|---|
page.image.path | Imagem de documento grande e de largura total. | Imagens altas empurrarão o conteúdo para baixo na página. 1600 x 600 é um bom tamanho intermediário a ser alcançado. |
page.image | Abreviação de page.image.path quando usado sozinho (sem thumbnail , caption ou outras variáveis). | O mesmo que page.image.path |
page.image.thumbnail | Imagem de documento pequeno usada na visualização em grade. | 400 x 200 |
author.picture | Imagem da página do autor. | 300 x 300 |
A estrutura, estilo e scripts padrão deste tema podem ser substituídos e personalizados das duas maneiras a seguir.
Os padrões do tema podem ser substituídos colocando um arquivo com o mesmo nome no diretório _includes ou _layouts do seu projeto. Por exemplo:
_includes/head.html , crie um diretório _includes em seu projeto, copie _includes/head.html da pasta gem do Basicamente Basic para <your_project>/_includes e comece a editar esse arquivo. Dica: para localizar os arquivos do tema em seu computador, execute bundle info jekyll-theme-basically-basic . Isso retorna a localização dos arquivos de tema baseados em gem.
Para substituir o Sass padrão (localizado no diretório _sass do tema), siga um destes procedimentos:
Copie diretamente da gema Basicamente Básica
bundle info jekyll-theme-basically-basic para obter o caminho para ele)./assets/stylesheets/main.scss de lá para <your_project> .<your_project>/assets/stylesheets/main.scss .Copie deste repositório.
<your_project> .<your_project/assets/stylesheets/main.scss . Nota: Para fazer alterações mais extensas e personalizar os parciais Sass incluídos na gema. Você precisará copiar o conteúdo completo do diretório _sass para <your_project> devido à forma como o Jekyll atualmente lê esses arquivos.
Para fazer ajustes básicos no estilo do tema, as variáveis Sass podem ser substituídas adicionando-as <your_project>/assets/stylesheets/main.scss . Por exemplo, para alterar a cor de destaque usada em todo o tema, adicione o seguinte:
$accent-color : red ;Para substituir o JavaScript padrão incluído no tema, siga um destes procedimentos:
Copie diretamente da gema Basicamente Básica
bundle info jekyll-theme-basically-basic para obter o caminho para ele)./assets/javascripts/main.js de lá para <your_project> .<your_project>/assets/javascripts/main.js .Copie deste repositório.
<your_project> .<your_project>/assets/javascripts/main.js . O tema usa logotipos de redes sociais e outras iconografias salvas como SVGs para desempenho e flexibilidade. Os referidos SVGs estão localizados no diretório _includes e prefixados com icon- . Cada ícone foi dimensionado e projetado para caber em uma caixa de visualização 16 x 16 e otimizado com SVGO.
| Ícone | Nome do arquivo |
|---|---|
| ícone-seta-esquerda.svg | |
| ícone-seta-direita.svg | |
| ícone-bitbucket.svg | |
| icon-calendar.svg | |
| icon-codepen.svg | |
| download de ícone.svg | |
| icon-dribbble.svg | |
| ícone-email.svg | |
| ícone-facebook.svg | |
| ícone-flickr.svg | |
| ícone-github.svg | |
| ícone-gitlab.svg | |
| ícone-googleplus.svg | |
| ícone-instagram.svg | |
| ícone-lastfm.svg | |
| ícone-linkedin.svg | |
| ícone-pdf.svg | |
| ícone-pinterest.svg | |
| ícone-rss.svg | |
| ícone-soundcloud.svg | |
| icon-stackoverflow.svg | |
| icon-cronômetro.svg | |
| icon-tumblr.svg | |
| ícone-twitter.svg | |
| ícone-xing.svg | |
| ícone-youtube.svg |
As cores de preenchimento são definidas no parcial _sass/basically-basic/_icons.scss e definidas com .icon-name onde o nome da classe corresponde ao ícone correspondente.
Por exemplo, o ícone do Twitter recebe uma cor de preenchimento #1da1f2 assim:
< span class =" icon icon--twitter " > {% include icon-twitter.svg %} </ span >Juntamente com os ativos SVG, existem ícones auxiliares incluídos para auxiliar na geração de links de redes sociais.
| Incluir parâmetro | Descrição | Obrigatório |
|---|---|---|
username | Nome de usuário em determinada rede social | Obrigatório |
label | Texto usado para hiperlink | Opcional, o padrão é username |
Por exemplo, o seguinte icon-github.html inclui:
{% include icon-github . html username = jekyll label = 'GitHub' %}Irá gerar o seguinte HTML:
< a href =" https://github.com/jekyll " >
< span class =" icon icon--github " > < svg viewBox =" 0 0 16 16 " xmlns =" http://www.w3.org/2000/svg " fill-rule =" evenodd " clip-rule =" evenodd " stroke-linejoin =" round " stroke-miterlimit =" 1.414 " > < path d =" M8 0C3.58 0 0 3.582 0 8c0 3.535 2.292 6.533 5.47 7.59.4.075.547-.172.547-.385 0-.19-.007-.693-.01-1.36-2.226.483-2.695-1.073-2.695-1.073-.364-.924-.89-1.17-.89-1.17-.725-.496.056-.486.056-.486.803.056 1.225.824 1.225.824.714 1.223 1.873.87 2.33.665.072-.517.278-.87.507-1.07-1.777-.2-3.644-.888-3.644-3.953 0-.873.31-1.587.823-2.147-.09-.202-.36-1.015.07-2.117 0 0 .67-.215 2.2.82.64-.178 1.32-.266 2-.27.68.004 1.36.092 2 .27 1.52-1.035 2.19-.82 2.19-.82.43 1.102.16 1.915.08 2.117.51.56.82 1.274.82 2.147 0 3.073-1.87 3.75-3.65 3.947.28.24.54.73.54 1.48 0 1.07-.01 1.93-.01 2.19 0 .21.14.46.55.38C13.71 14.53 16 11.53 16 8c0-4.418-3.582-8-8-8 " > </ path > </ svg > </ span >
< span class =" label " > GitHub </ span >
</ a >Para configurar seu ambiente para desenvolver este tema:
cd em /example e execute bundle install .Para testar o tema localmente à medida que você faz alterações nele:
cd na pasta raiz do repositório (por exemplo, jekyll-theme-basically-basic ).bundle exec rake preview e abra seu navegador em http://localhost:4000/example/ . Isso inicia um servidor Jekyll usando os arquivos do tema e o conteúdo do diretório example/ . À medida que as modificações são feitas, atualize seu navegador para ver as alterações.
Encontrou um erro de digitação na documentação? Interessado em adicionar um recurso ou corrigir um bug? Em seguida, envie um problema ou tente enviar uma solicitação pull. Se esta for sua primeira solicitação pull, pode ser útil ler o GitHub Flow.
Ao enviar uma solicitação pull:
master e dê a ela um nome significativo (por exemplo, my-awesome-new-feature ) e descreva o recurso ou correção. Páginas de amostra podem ser encontradas nas pastas /docs e /example se você quiser resolver qualquer "fruto mais fácil", como corrigir erros de digitação, gramática incorreta, etc.
Michael Rosa
A Licença MIT (MIT)
Copyright (c) 2017-2021 Michael Rose e colaboradores
É concedida permissão, gratuitamente, a qualquer pessoa que obtenha uma cópia deste software e dos arquivos de documentação associados (o "Software"), para negociar o Software sem restrições, incluindo, sem limitação, os direitos de usar, copiar, modificar, mesclar , publicar, distribuir, sublicenciar e/ou vender cópias do Software e permitir que as pessoas a quem o Software seja fornecido o façam, sujeito às seguintes condições:
O aviso de direitos autorais acima e este aviso de permissão serão incluídos em todas as cópias ou partes substanciais do Software.
O SOFTWARE É FORNECIDO "COMO ESTÁ", SEM GARANTIA DE QUALQUER TIPO, EXPRESSA OU IMPLÍCITA, INCLUINDO, MAS NÃO SE LIMITANDO ÀS GARANTIAS DE COMERCIALIZAÇÃO, ADEQUAÇÃO A UM DETERMINADO FIM E NÃO VIOLAÇÃO. EM HIPÓTESE ALGUMA OS AUTORES OU DETENTORES DE DIREITOS AUTORAIS SERÃO RESPONSÁVEIS POR QUALQUER RECLAMAÇÃO, DANOS OU OUTRA RESPONSABILIDADE, SEJA EM UMA AÇÃO DE CONTRATO, ATO ILÍCITO OU DE OUTRA FORMA, DECORRENTE DE, OU EM CONEXÃO COM O SOFTWARE OU O USO OU OUTRAS NEGOCIAÇÕES NO SOFTWARE.
Basicamente Basic incorpora ícones do The Noun Project. Os ícones são distribuídos sob Creative Commons Attribution 3.0 United States (CC BY 3.0 US).
Basicamente Basic incorpora fotografias do Unsplash.
Basicamente Basic incorpora Susy, Copyright (c) 2017, Miriam Eric Suzanne. Susy é distribuído sob os termos da licença BSD de 3 cláusulas "Nova" ou "Revisada".
Basicamente o Basic incorpora o Breakpoint. Breakpoint é distribuído sob os termos das licenças MIT/GPL.
