← Guias

Guia Sanctuary

Índice automático e progresso para documentos Markdown longos

O Sanctuary Reader gera índice automático, barra de progresso e estatísticas para navegar melhor em documentos Markdown longos.

Atualizado
markdownindice-automaticonavegacaoleitura-longadocumentacao

Neste guia
  1. Como funciona o índice automático
  2. Como preparar o documento
  3. Como usar durante a leitura
  4. Quando o índice fica melhor
  5. Use a estrutura em outros modos

Como funciona o índice automático

Um documento Markdown longo fica mais fácil de ler quando suas partes aparecem organizadas. O Sanctuary Reader cria um índice lateral a partir dos títulos do arquivo e acompanha a seção ativa enquanto você rola o texto.

Além do índice, a interface mostra a barra de progresso, a quantidade de palavras, o tempo estimado de leitura e o total de seções encontradas.

Como preparar o documento

Use títulos Markdown para marcar os assuntos principais:

# Título do documento

## Introdução

## Decisão principal

### Detalhes da decisão

Os títulos ## e ### formam as seções usadas pelo Reader. Um título principal em # ajuda a nomear o documento, enquanto os níveis seguintes dividem o conteúdo em partes navegáveis.

Como usar durante a leitura

  1. Abra um documento Markdown no Reader.
  2. Localize o índice na lateral.
  3. Selecione um título para saltar até a seção correspondente.
  4. Continue a leitura normalmente: o índice destaca o ponto em que você está.
  5. Consulte a barra superior para ter uma noção do progresso no arquivo.

Essa organização evita que você dependa apenas da rolagem para encontrar uma seção. Ela é especialmente útil em READMEs, especificações, apostilas e documentos de reunião.

Quando o índice fica melhor

Um índice útil depende de títulos claros. Prefira nomes que indiquem o assunto da seção, como ## Instalação, ## Limites ou ## Próximos passos, em vez de títulos vagos como ## Mais ou ## Parte 2.

Se o documento chegou como um bloco longo de texto, você pode abrir o editor com preview ao vivo e inserir títulos antes de voltar ao Reader.

Use a estrutura em outros modos

As mesmas seções que aparecem no índice também melhoram o modo foco, os cards e a apresentação. Para uma leitura mais ativa, o estudo guiado usa essa divisão para propor registros por seção.