Communitygithub.com

imswarnil/Personal-Website-Jekyll-Theme

Monte um site pessoal com este tema Jekyll — blog, portfólio, vídeos, séries, cursos, podcast, newsletter, viagens, equipamentos e currículo — e implante no GitHub Pages em username.github.io. Use quando alguém quiser criar seu próprio site a partir deste repositório, adicionar ou remodelar uma coleção, alterar a composição de uma página de entrada ou implantá-lo pela primeira vez.

O que é Personal-Website-Jekyll-Theme?

Este tema Jekyll é orientado a dados, não a templates, permitindo personalização profunda via `_config.yml` e arquivos em pastas, sem editar layouts. Ele suporta a criação rápida de sites pessoais com blog, portfólio, cursos, podcast e muito mais, através de um assistente de configuração (`npm run setup`) que gera o `_config.yml` com segurança. A implantação no GitHub Pages é simples, usando GitHub Actions e um workflow que lida automaticamente com `baseurl`. As coleções de conteúdo são fáceis de adicionar e cada uma pode ter sua própria página de entrada com `parts`, `widgets` e `lead` customizáveis, tudo sem tocar em layouts. O tema também inclui páginas de tags, design cards consistentes e comandos npm para desenvolvimento, build e verificação. É ideal para desenvolvedores que querem um site pessoal moderno, flexível e de baixa manutenção.

Funciona com~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/imswarnil/Personal-Website-Jekyll-Theme/tree/HEAD/.claude/skills/personal-site

Perguntar na sua IA favorita

Abre um novo chat com esta habilidade de agente já pré-carregada.

Documentação

Construa um site pessoal com este tema

Este tema é composto a partir de dados, não de templates. Quase toda alteração solicitada é uma mudança em _config.yml mais um arquivo colocado em uma pasta — se você estiver editando um layout, verifique este documento primeiro, porque o hook que você precisa provavelmente já existe.

1. O caminho mais rápido: o assistente de configuração

npm run setup          # abre um formulário local, escreve _config.yml, faz backup do que substitui

Ele vincula apenas a 127.0.0.1, nunca envia nada e copia tudo que substitui para .imprint-backup/<timestamp>/ primeiro. Ele pré-preenche a partir da configuração atual, portanto é seguro executá-lo novamente mais tarde.

O assistente cobre identidade, cor de destaque, cabeçalho e rodapé, navegação, links sociais, coleções, anúncios, analytics, endpoint de newsletter e o domínio. Ele deliberadamente não cobre a composição de página por coleção — ele mantém essas chaves intactas (veja §4).

Em seguida:

npm run dev            # http://localhost:4000
npm run check          # doctor + build de produção

2. Implantando em username.github.io

  1. Crie um repositório com o nome exato username.github.io (uma página de usuário), ou qualquer nome para uma página de projeto.
  2. Envie esta árvore para main.
  3. Configurações → Pages → Source: GitHub Actions.

.github/workflows/jekyll.yml compila com Ruby 3.4 e implanta _site/. Ele passa --baseurl "${{ steps.pages.outputs.base_path }}", então o mesmo workflow é correto para uma página de usuário (caminho base vazio) e uma página de projeto (/repo-name/) — não codifique baseurl.

CNAME contém o domínio personalizado. Sem domínio personalizado → delete o arquivo; o assistente faz isso para você quando você deixa o domínio em branco.

3. Adicionando uma coleção

Uma coleção é um tipo de conteúdo: blog, portfólio, podcast, uma prateleira de equipamentos. Adicione uma em _config.yml sob collections::

  recipes:
    output: true
    title: Receitas
    singular: Receita
    description: "Uma linha sobre esta coleção."
    permalink: /recipes/:name/
    landing: /recipes/
    icon: cooking-pot          # qualquer nome de phosphoricons.com
    schema: Recipe             # tipo schema.org, para JSON-LD
    card: blog                 # qual design de card (veja §5)
    hero: { pattern: dots }    # o hero da landing; `hero: false` para o cabeçalho compacto
    image: "/assets/img/covers/recipes.svg"
    single:                    # composição da página de entrada (veja §4)
      lead: cover
      parts: [breadcrumbs, head, lead, prose, tags, share, ask, author, nav]
      widgets: [toc, collection, about]

Em seguida:

mkdir _recipes                       # a pasta que o Jekyll lê
# uma página de landing que lista a coleção:
printf -- '---\nlayout: page\ntitle: Receitas\npermalink: /recipes/\nlist_collection: recipes\n---\n' > recipes.html
npm run thumbs                       # desenha a arte de capa para a nova coleção

npm run doctor informará se você perdeu alguma dessas etapas.

O tema oferece treze: posts, portfolio, videos, snippets, prompts, webseries + episodes, courses + lessons, podcast, newsletter, travel, uses. Uma coleção filha (um episódio, uma lição) pertence ao seu pai por um slug no front matter — series: ou course:.

4. Alterando a composição de uma página de entrada

Esta é a parte que as pessoas normalmente acham que precisa de um novo layout. Não precisa.

    single:
      lead: portfolio                 # _includes/leads/portfolio.html
      parts: [breadcrumbs, head, lead, prose, tags, share, ask, comments, author, nav]
      widgets: [details, toc, collection, cta]
      sidebar: true
  • parts → _includes/single/<nome>.html, empilhados na ordem fornecida
  • widgets → _includes/widgets/<nome>.html, na barra lateral
  • lead → _includes/leads/<nome>.html (none para sem lead)

Crie uma parte simplesmente colocando um arquivo na pasta e nomeando-o. Nenhum layout é editado. Qualquer entrada individual pode substituir todos os três em seu próprio front matter.

Partes incluídas: breadcrumbs head toc-mobile lead prose tags share ask comments author nav episodes lessons siblings. Widgets: toc details collection about cta share subscribe ad. Leads: cover video prompt snippet portfolio series audio.

5. Designs de cards

card: <nome> em uma coleção seleciona _includes/cards/<nome>.html. Incluídos: blog (editorial), portfolio (card de repositório), video (player), snippet (janela de código), prompt (janela de chat), webseries (pôster retrato), episode, course, lesson, podcast, issue, trip, product. Não definido, volta para blog, então uma nova coleção parece correta antes de ter um design próprio.

Cards em uma linha de grade têm sempre a mesma altura. .im-cards estica cada item e o corpo do card absorve a folga — então um novo card só precisa colocar flex: 1 em seu corpo e margin-top: auto em seu rodapé.

6. Páginas de tags

_plugins/tag_pages.rb escreve uma página por tag em /tags/<slug>/, em todas as coleções — o site.tags nativo do Jekyll só vê posts, o que em um site que também marca filmes e equipamentos mostraria silenciosamente apenas um terço do que carrega a tag. Tags são agrupadas por slug, então Analytics e analytics são um único assunto.

Um gerador em _plugins/ é executado sempre que o Jekyll é invocado por nós, que é o que .github/workflows/jekyll.yml faz. Ele não seria executado sob o modo legado "build a partir de um branch" do GitHub Pages; nesse caso, defina tag_pages: false e os links de tag voltam para âncoras em /tags/.

7. Estilo da casa — leia antes de escrever CSS

O tema segue o Im Design System e tem exatamente duas interações:

  • HOVER — a coisa PREENCHE (--im-hover-bg). Nada afia uma borda, nada cresce três por cento, nada se apoia em uma sombra projetada.
  • ATUAL — "você está aqui": um preenchimento mais forte e um rótulo mais destacado (--im-current-bg/-fg/-weight). Nunca é uma mudança de cor.

O destaque é para o botão primário, o hover de um link, o anel de foco, seleção e o matiz derivado de cada coleção — nada mais. Um botão preenchido é um botão preenchido, um card é um card; ambos levantam exatamente um pixel e projetam uma linha fina.

Tudo é uma propriedade customizada --im-*; nada é uma cor literal. _sass/im/abstracts/_mixins.scss contém ambas as interações, escritas uma vez.

8. Os comandos

npm run setup     # o formulário de configuração no navegador
npm run dev       # servidor local + recarga ao vivo
npm run build     # build de produção em _site/
npm run new       # scaffold de uma entrada em qualquer coleção
npm run thumbs    # (re)desenha a arte de capa gerada a partir da cor de destaque
npm run doctor    # verifica a configuração para erros que quebram o build
npm run test      # suíte de testes da configuração/assistente
npm run check     # doctor + build, ou seja, o que o CI faz

Ruby 3.4 é necessário (.ruby-version); o Ruby 2.6 do sistema do macOS não consegue compilar este site. bin/serve e bin/build forçam o toolchain correto no PATH.

Individual skills in this repo

This repo contains 1 individual skill — each has its own dedicated page.

Habilidades Relacionadas