Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

Load markdown from external sources

Aberta
#229 1 comentário 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
5/5
Tempo estimado
Mais de uma semana
Facilidade para iniciantes
25/100
Tipo de issue
Funcionalidade
Clareza
Precisa de esclarecimento
Status de atividade
Estagnada
Stack de tecnologia
javascript, nodejs
Domínio
cli, documentation

Direção de pesquisa

Comece revisando como o docsify-cli atualmente varre diretórios e cria links Markdown e caminhos de URL. Defina o comportamento do mapa externo de README.md e baseUrl, incluindo substituições locais para desenvolvimento e testes. Está concluído quando repositórios externos configurados puderem aparecer na navegação da documentação publicada e os mapeamentos locais funcionarem conforme o esperado.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

I plan on using docsify for repo docs. One of the requirements I have is to have one repo link out to each repo's docs index file (README.md). This main repo will be the org-wide repo with a table of contents of all other documentation as well as organization/high-level documentation. The goal is to publish this org-wide docs repo and have it be the primary knowledge source for the organization which would include each repo's documentation on that website.

In order to do this, it would make sense if I can link to other external README.md files by URL. Right now docsify reads the directory to create table of contents and URL paths. Could it also grep (using ripgrep for fast file search) for all markdown links and source paths/pages from external? One could configure a baseUrl map so it only looks for links including a baseUrl in the map. The baseUrl table could allow for developers to map baseUrls to some overrides for local development and testing with the locally cloned repos.

Linguagem predominante
JavaScript
Estrelas
781
Forks
166
Merge médio
10h 49min
PRs com merge (30d)
1

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de docsifyjs/docsify-cli

Todas as issues de docsifyjs/docsify-cli

Issues semelhantes

Mais issues de JavaScript

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.