Pular para o conteúdo
Skillpedia
Escrita40 mil · #5408

update-markdown-file-index

Cria um índice de arquivos em um documento. Ajuda a organizar e listar arquivos de uma pasta específica dentro de um arquivo Markdown.

O que ela faz

Esta ferramenta cria automaticamente uma lista ou tabela de arquivos de uma pasta específica dentro de um documento de texto (arquivo Markdown). Ela organiza os arquivos, mostrando seus nomes, tipos e descrições.

Quando usar

  • ✓Quando você quer listar todos os arquivos de um projeto em um documento.
  • ✓Ao criar um README para organizar a documentação de um diretório.
  • ✓Para gerar um índice de exemplos de código em um arquivo de notas.

Exemplo do que pedir para a IA

“Crie um índice dos arquivos da pasta 'documentos' no meu arquivo 'README.md'.”

Quer saber mais? Abra as seções abaixo.

Como usar

O jeito mais fácil: copie a mensagem abaixo e cole no Claude, ChatGPT, Cursor ou outra IA. Ela lê a skill e segue as instruções.

Link da skill

https://github.com/github/awesome-copilot/blob/main/skills/update-markdown-file-index/SKILL.md

Mensagem pronta para colar

Use esta skill para me ajudar: https://github.com/github/awesome-copilot/blob/main/skills/update-markdown-file-index/SKILL.md Leia o arquivo SKILL.md desse link e siga as instruções dele na minha tarefa.
Como funciona

A IA lê o seu arquivo principal, procura a pasta que você indicou, lista os arquivos lá dentro e cria uma lista ou tabela organizada com as informações de cada arquivo, inserindo isso no seu documento.

Instalação

Jeito mais fácil: copie o link da skill e cole no Claude, ChatGPT ou Cursor pedindo para seguir as instruções.

No terminal (Claude Code, Codex, Cursor), na pasta do projeto:

npx skills add github/awesome-copilot --skill update-markdown-file-index

Ou baixe só o arquivo:

curl -L https://raw.githubusercontent.com/github/awesome-copilot/main/skills/update-markdown-file-index/SKILL.md -o SKILL.md
Conteúdo técnico (SKILL.md)

Tradução do texto original do autor no GitHub. Os comandos e códigos estão como no original.

Atualizar Índice de Arquivos Markdown

Atualize o arquivo markdown ${file} com um índice/tabela de arquivos da pasta ${input:folder}.

Processo

  1. Escanear: Leia o arquivo markdown alvo ${file} para entender a estrutura existente.
  2. Descobrir: Liste todos os arquivos na pasta especificada ${input:folder} que correspondem ao padrão ${input:pattern}.
  3. Analisar: Identifique se uma seção de tabela/índice existente precisa ser atualizada ou se uma nova estrutura deve ser criada.
  4. Estruturar: Gere o formato de tabela/lista apropriado com base nos tipos de arquivo e no conteúdo existente.
  5. Atualizar: Substitua a seção existente ou adicione uma nova seção com o índice de arquivos.
  6. Validar: Garanta que a sintaxe markdown seja válida e que a formatação seja consistente.

Análise de Arquivos

Para cada arquivo descoberto, extraia:

  • Nome: Nome do arquivo com ou sem extensão, dependendo do contexto.
  • Tipo: Extensão do arquivo e categoria (por exemplo, .md, .js, .py).
  • Descrição: Comentário da primeira linha, cabeçalho ou propósito inferido.
  • Tamanho: Tamanho do arquivo para referência (opcional).
  • Modificado: Data da última modificação (opcional).

Opções de Estrutura de Tabela

Escolha o formato com base nos tipos de arquivo e no conteúdo existente:

Opção 1: Lista Simples

## Files in ${folder}

- [filename.ext](path/to/filename.ext) - Description
- [filename2.ext](path/to/filename2.ext) - Description

Opção 2: Tabela Detalhada

| File | Type | Description |
|------|------|-------------|
| [filename.ext](path/to/filename.ext) | Extension | Description |
| [filename2.ext](path/to/filename2.ext) | Extension | Description |

Opção 3: Seções Categorizadas

Agrupe arquivos por tipo/categoria com seções ou sub-tabelas separadas.

Estratégia de Atualização

  • 🔄 Atualizar existente: Se a seção de tabela/índice existir, substitua o conteúdo preservando a estrutura.
  • ➕ Adicionar novo: Se não houver seção existente, crie uma nova seção usando o formato mais adequado.
  • 📋 Preservar: Mantenha a formatação markdown existente, níveis de cabeçalho e fluxo do documento.
  • 🔗 Links: Use caminhos relativos para links de arquivos dentro do repositório.

Identificação de Seção

Procure por seções existentes com estes padrões:

  • Cabeçalhos contendo: "índice", "arquivos", "conteúdo", "diretório", "lista".
  • Tabelas com colunas relacionadas a arquivos.
  • Listas com links de arquivos.
  • Comentários HTML marcando seções de índice de arquivos.

Requisitos

  • Preservar a estrutura e formatação markdown existentes.
  • Usar caminhos relativos para links de arquivos.
  • Incluir descrições de arquivos quando disponíveis.
  • Ordenar arquivos alfabeticamente por padrão.
  • Lidar com caracteres especiais em nomes de arquivos.
  • Validar toda a sintaxe markdown gerada.
Perguntas frequentes

O que é um arquivo Markdown?

Markdown é um formato de texto simples que permite formatar o texto usando caracteres especiais, como asteriscos para negrito ou listas. É muito usado para documentação na internet.

Como a IA sabe quais arquivos listar?

Você diz para a IA qual pasta procurar. Ela também pode usar um 'padrão' para filtrar quais tipos de arquivos incluir, como apenas arquivos '.txt' ou '.py'.

A IA vai apagar o conteúdo que já existe no meu arquivo?

Não, a IA tenta ser inteligente. Se já existir uma lista de arquivos, ela atualiza essa lista. Se não existir, ela cria uma nova seção para a lista, sem estragar o resto do seu documento.

Detalhes

Descrição original do autor

Update a markdown file section with an index/table of files from a specified folder.

repo: github/awesome-copilot

Popularidade

Estrelas no GitHub
40 mil
Posição no ranking
#5408
Licença
MIT
Atualizada em
15/10/2026

Essa skill é útil?

0

Entre para votar.

Comentários

  • …

Mais skills deste repositório

Skills parecidas