Skip to content

Latest commit

 

History

History
393 lines (262 loc) · 22.8 KB

File metadata and controls

393 lines (262 loc) · 22.8 KB

multi-language-al-folio

Pré-visualização

Uma versão multilíngue do tema al-folio, um tema Jekyll simples, limpo e responsivo para acadêmicos.


deploy Status no Netlify Mantenedores Contribuidores no GitHub

Versão da Imagem Docker Tamanho da Imagem Docker Pulls do Docker

GitHub release Licença no GitHub Estrelas no GitHub Forks no GitHub

Code Wiki DeepWiki

en-us

Comunidade de Usuários

A vibrante comunidade de usuários do al-folio está crescendo! Acadêmicos ao redor do mundo utilizam este tema para suas páginas pessoais, blogs, páginas de laboratórios, assim como para cursos, workshops, conferências, encontros e muito mais. Confira as páginas da comunidade no README em inglês. Sinta-se à vontade para adicionar a(s) sua(s) própria(s) página(s) enviando um PR.

Lighthouse PageSpeed Insights

Desktop

Google Lighthouse PageSpeed Insights

Execute o teste você mesmo: Google Lighthouse PageSpeed Insights

Mobile

Google Lighthouse PageSpeed Insights

Execute o teste você mesmo: Google Lighthouse PageSpeed Insights

Índice

Começando

Quer aprender mais sobre Jekyll? Confira este tutorial. Por que Jekyll? Leia o post no blog do Andrej Karpathy! Por que escrever um blog? Leia o post da Rachel Thomas.

Instalação e Implantação

Para detalhes de instalação e implantação, consulte INSTALL.md.

Personalizando

Para detalhes de personalização, consulte CUSTOMIZE.md.

Agentes do GitHub Copilot

Este repositório inclui dois agentes especializados do GitHub Copilot para melhorar sua experiência de desenvolvimento:

Agente de Personalização

O Agente de Personalização ajuda você a personalizar seu site al-folio, oferecendo:

  • Orientação passo a passo para alterações de configuração
  • Modificação direta de arquivos em seu repositório
  • Explicação de conceitos técnicos em linguagem simples (ótimo para usuários sem experiência em programação)
  • Assistência com tarefas comuns, como atualizar seu CV, adicionar publicações, criar postagens de blog e personalizar temas

Consulte CUSTOMIZE.md § Agente de Personalização do GitHub Copilot para obter instruções detalhadas de uso.

Agente de Documentação

O Agente de Documentação mantém a documentação do projeto clara e atualizada, realizando:

  • Atualização de arquivos de documentação quando os recursos mudam
  • Redação em um estilo acessível para acadêmicos e pesquisadores
  • Manutenção da sincronização da documentação com a base de código
  • Seguindo as melhores práticas de documentação

Consulte CONTRIBUTING.md § Agentes do GitHub Copilot para obter mais informações.

Requisitos: Ambos os agentes exigem uma assinatura do GitHub Copilot. Para mais informações sobre o GitHub Copilot e como usar agentes, consulte a documentação do GitHub Copilot.

Recursos

Suporte Multilíngue

Em uma versão anterior, isso era feito utilizando o jekyll-multiple-languages-plugin, mas como o repositório do plugin foi arquivado, ele foi substituído pelo plugin polyglot. Este plugin foi criado com base nas funcionalidades do jekyll-multiple-languages-plugin e é mantido ativamente. Para mais informações sobre essa mudança, veja UPGRADING.md.

O idioma padrão (usado como alternativa caso um link para outro idioma não seja encontrado) será o definido como default_lang no arquivo _config.yml. Ao utilizar dois idiomas, o tema exibirá um botão no cabeçalho que alterna diretamente para o outro idioma.

Alternar idioma Voltar o idioma

Também é possível exibir a bandeira do país em vez do nome do idioma.

Usar bandeira do país em vez do nome do idioma

Ao utilizar três ou mais idiomas, um menu dropdown será criado com todas as línguas disponíveis.

Alternar idioma entre 3 ou mais

Note que, ao longo dos arquivos README.md e CUSTOMIZE.md, o idioma padrão é o inglês (LANG = en-us). Você deve ter um arquivo ou caminho equivalente para cada idioma definido no _config.yml. Por exemplo, se você definiu languages: ["en-us", "pt-br"], deverá ter 2 versões do arquivo _data/LANG/cv.yml: _data/en-us/cv.yml e _data/pt-br/cv.yml.


Modo Claro/Escuro

Este template possui um modo claro/escuro embutido. Ele detecta a preferência de esquema de cores do usuário e alterna automaticamente. Você também pode alternar manualmente entre os modos claro e escuro clicando no ícone de sol/lua no canto superior direito da página.


Currículo (CV)

Atualmente, existem 2 formas de gerar o conteúdo da página do currículo. A primeira utiliza um arquivo json localizado em assets/json/resume_LANG.json. Trata-se de um padrão conhecido para criar um currículo programaticamente. A segunda, atualmente utilizada como alternativa quando o arquivo json não for encontrado, usa um arquivo yml localizado em _data/LANG/cv.yml. Esta foi a forma original de criar o conteúdo da página do currículo e, por ser mais legível, decidimos mantê-la como opção.

Ou seja, se não houver dados de currículo definidos no _config.yml e carregados via um arquivo json, o conteúdo de _data/LANG/cv.yml será usado como alternativa.

Pré-visualização do Currículo


Pessoas

Você pode criar uma página de pessoas caso deseje apresentar mais de uma pessoa. Cada pessoa pode ter sua própria bio breve, foto de perfil e definir se todas as pessoas aparecerão em lados opostos ou iguais.

Pré-visualização de Pessoas


Publicações

A página de publicações é gerada automaticamente a partir da sua bibliografia em BibTex. Basta editar _bibliography/papers.bib. Você também pode adicionar novos arquivos *.bib e personalizar a aparência de suas publicações editando _pages/LANG/publications.md. Por padrão, as publicações são ordenadas por ano, exibindo as mais recentes primeiro. Você pode alterar esse comportamento e outros detalhes na seção Jekyll Scholar do arquivo _config.yml.

Você pode adicionar informações extras a uma publicação, como um arquivo PDF na pasta assets/pdf/ e informar o caminho para o arquivo no registro BibTeX com o campo pdf. Alguns dos campos suportados são: abstract, altmetric, arxiv, bibtex_show, blog, code, dimensions, doi, eprint, html, isbn, pdf, pmid, poster, slides, supp, video e website.

Pré-visualização das Publicações


Coleções

Este tema Jekyll utiliza collections para que você possa categorizar seu trabalho. O tema já vem com duas coleções padrão: news e projects. Itens da coleção news são automaticamente exibidos na página inicial. Itens da coleção projects são apresentados em uma grade responsiva na página de projetos.

Pré-visualização dos Projetos

Você pode facilmente criar suas próprias coleções, como apps, contos, cursos ou qualquer outro trabalho criativo. Para isso, edite as coleções no arquivo _config.yml, crie uma pasta correspondente e uma página de entrada para sua coleção, similar ao arquivo _pages/projects.md.


Layouts

O al-folio vem com layouts elegantes para páginas e posts de blog.

O estilo icônico do Distill

O tema permite que você crie posts de blog no estilo do distill.pub:

Pré-visualização Distill

Para mais detalhes sobre como criar posts no estilo distill utilizando as tags <d-*>, consulte o exemplo.

Suporte completo para matemática e código

O al-folio oferece suporte rápido para renderização de fórmulas matemáticas via MathJax e para realce de sintaxe de código utilizando o estilo do GitHub. Também suporta gráficos com chartjs, diagramas com mermaid, e figuras em TikZ.

exemplo de post com matemática exemplo de post com código

Fotos, Áudio, Vídeo e mais

A formatação de fotos é simplificada utilizando o sistema de grid do Bootstrap. Crie facilmente grades bonitas em seus posts e páginas de projetos, com suporte também para adição de vídeo e áudio:


Outros recursos

Repositórios do GitHub e estatísticas do usuário

O al-folio utiliza github-readme-stats e github-profile-trophy para exibir repositórios e estatísticas do usuário na página /repositories/.

Pré-visualização de Repositórios

Edite o arquivo _data/repositories.yml e altere as listas github_users e github_repos para incluir seu perfil e repositórios desejados na página /repositories/.

Você também pode usar os códigos abaixo para exibir isso em outras páginas.

<!-- código para usuários do GitHub -->
{% if site.data.repositories.github_users %}
<div class="repositories d-flex flex-wrap flex-md-row flex-column justify-content-between align-items-center">
  {% for user in site.data.repositories.github_users %} {% include repository/repo_user.liquid username=user %} {% endfor %}
</div>
{% endif %}

<!-- código para troféus do GitHub -->
{% if site.repo_trophies.enabled %} {% for user in site.data.repositories.github_users %} {% if site.data.repositories.github_users.size > 1 %}
<h4>{{ user }}</h4>
{% endif %}
<div class="repositories d-flex flex-wrap flex-md-row flex-column justify-content-between align-items-center">
  {% include repository/repo_trophies.liquid username=user %}
</div>
{% endfor %} {% endif %}

<!-- código para repositórios do GitHub -->
{% if site.data.repositories.github_repos %}
<div class="repositories d-flex flex-wrap flex-md-row flex-column justify-content-between align-items-center">
  {% for repo in site.data.repositories.github_repos %} {% include repository/repo.liquid repository=repo %} {% endfor %}
</div>
{% endif %}

Temas

Uma variedade de cores de tema bonitas foi selecionada para você escolher. O padrão é roxo, mas você pode alterá-lo rapidamente editando a variável --global-theme-color no arquivo _sass/_themes.scss. Outras variáveis de cor estão listadas lá também. As opções de cor de tema disponíveis podem ser encontradas em _sass/_variables.scss. Você também pode adicionar suas próprias cores a este arquivo, atribuindo a cada uma um nome para facilitar o uso em todo o modelo.


Visualizações de mídia social

al-folio suporta imagens de visualização em mídias sociais. Para ativar essa funcionalidade, você precisa definir serve_og_meta para true em seu _config.yml. Depois de fazer isso, todas as páginas do seu site incluirão dados do Open Graph no elemento head HTML.

Você precisará então configurar qual imagem exibir nas visualizações de mídia social do seu site. Isso pode ser configurado por página, definindo a variável de página og_image. Se para uma página individual essa variável não for definida, o tema usará como fallback uma variável og_image em todo o site, configurável em seu _config.yml. Nos casos específicos da página e em todo o site, a variável og_image precisa conter a URL da imagem que deseja exibir nas visualizações de mídia social.


Feed Atom (semelhante a RSS)

Ele gera um feed Atom (semelhante a RSS) de suas postagens, útil para leitores de Atom e RSS. O feed é acessível simplesmente digitando após sua página inicial /feed.xml. Por exemplo, assumindo que o seu ponto de montagem do site seja a pasta principal, você pode digitar yourusername.github.io/feed.xml


Postagens relacionadas

Por padrão, haverá uma seção de postagens relacionadas na parte inferior das postagens do blog. Estas são geradas selecionando as max_related postagens mais recentes que compartilham pelo menos min_common_tags tags com a postagem atual. Se você não quiser exibir postagens relacionadas em uma postagem específica, simplesmente adicione related_posts: false ao front matter da postagem. Se quiser desativar para todas as postagens, simplesmente defina enabled para false na seção related_blog_posts em _config.yml.


Verificações de qualidade de código

Atualmente, executamos algumas verificações para garantir que a qualidade do código e o site gerado sejam bons. As verificações são feitas usando GitHub Actions e as seguintes ferramentas:

  • Prettier - verificar se a formatação do código segue o guia de estilo
  • lychee - verificar links quebrados
  • Axe (necessário executar manualmente) - fazer testes de acessibilidade

Decidimos manter as execuções do Axe manuais porque corrigir os problemas não é direto e pode ser difícil para pessoas sem conhecimento de desenvolvimento web.

Perguntas Frequentes

Para perguntas frequentes, consulte FAQ.pt-br.md.

Contribuindo

Contribuições para multi-language-al-folio são muito bem-vindas! Antes de começar, dê uma olhada em as orientações.

Se você gostaria de melhorar a documentação ou corrigir uma inconsistência ou bug menor, sinta-se livre para enviar um PR diretamente para main. Para problemas/bugs mais complexos ou solicitações de recursos, abra uma issue usando o modelo apropriado.

Mantenedores

Nossos colaboradores mais ativos são bem-vindos para se juntar à equipe de mantenedores. Se estiver interessado, entre em contato!


Maruan

Rohan Deb Sarkar

Amir Pourmand

George

Todos os Colaboradores

Histórico de Estrelas

Star History Chart

Licença

O tema está disponível como código aberto sob os termos da Licença MIT.

Originalmente, al-folio foi baseado no tema *folio (publicado por Lia Bogoev e sob a licença MIT). Desde então, ele recebeu uma reescrita completa dos estilos e muitos recursos legais adicionais.