VoltarLogo do GithubGithub

Documentação Gitfollio

Aprenda como usar o Gitfollio para criar seu portfólio em minutos

Contents

Primeiros Passos

O GitFollio permite que você crie um portfólio bonito a partir dos seus repositórios do GitHub em apenas alguns passos simples:

  1. Digite seu nome de usuário do GitHub na página inicial do GitFollio para buscar suas informações de perfil.
  2. Escolha um dos templates disponíveis para o seu portfólio.
  3. Personalize o portfólio com seu nome, frase de destaque (tagline) e outras informações.
  4. Visualize uma prévia do seu portfólio para ver como ele ficará.
  5. Crie um repositório especial no seu GitHub com o conteúdo de README fornecido.

Observação: O GitFollio utiliza o arquivo README.md do seu repositório especial para reunir informações sobre seus projetos.

Configuração do Repositório

Para que seu portfólio seja exibido corretamente com o GitFollio, você precisa criar um repositório especial no GitHub:

1. Crie o Repositório Especial

Crie um novo repositório público no GitHub com o nome exatamente igual ao seu nome de usuário do Github.

2. Adicione a Configuração no README

No arquivo README.md, adicione a configuração do seu portfólio entre as tags de comentário especiais do GitFollio:

# Your Portfolio Name

  <!-- GitFolio:start -->
  {
  gitfolio: "on",
  name: "Meu Nome",
  email: "meu.email@exemplo.com",
  tagline: "Software Developer & Designer",
  avatar_url: "https://link-meu-avatar",
  website: "https://meu-site.com.br"
  githubUser: "meuusuario",
  linkedinUser: "https://www.linkedin.com/in/meuusuario/",
  about: "Uma breve descrição sobre mim",
  tech: ["JavaScript", "React", "Node.js"],
  showStars: true,
  showFollowers: true,
  followers: 189,
  following: 99,
  themeId: "minimal",
  projects: { 
    id: 12345678,
    repoName: "meuProjeto", 
    url: "https://github.com/meuusuario/meuprojeto", 
    stars: 37, 
    description?: "Uma descrição sobre o projeto",
    image: https://link-da-image.com, 
    techs: ["Node.js", "Nest.JS", "TypeScript"], 
    deploy: https://link-do-projeto.com,
    highlighted: true,
  };
}
  <!-- GitFolio:end -->

  Restante do seu conteúdo README ...
OBS: Não se preocupe. Essas configurações não ficarão visíveis.

Temas

O GitFollio oferece diversos modelos para exibir seu portfólio com estilos visuais variados. Você pode escolher um durante a criação do portfólio ou atualizando a configuração diretamente no seu repositório GitFollio.

Minimal

Design limpo e focado, com o mínimo de distrações. Ideal para destacar seus projetos de forma direta e objetiva.

Modern

Layout contemporâneo com componentes elegantes e animações suaves, oferecendo um visual moderno e refinado.

Creative

Design ousado com elementos de layout únicos e efeitos visuais marcantes, ideal para profissionais criativos que querem se destacar.

Professional

Visual sofisticado com tipografia elegante e layout estruturado, perfeito para contextos mais corporativos ou formais.

Dark

Interface com tema escuro e elementos de alto contraste, ideal para desenvolvedores e entusiastas do modo noturno.

Cyberpunk

Estilo futurista com cores neon vibrantes, contrastes fortes e estética inspirada em tecnologia urbana e ficção científica. Perfeito para quem quer um visual impactante, com vibe tech rebelde e atmosfera digital intensa.

Observação: Todos os modelos são responsivos e funcionam bem em qualquer tamanho de tela.

Perguntas Frequentes