Lendo arquivos Markdown no terminal (*.md)

Publicado por Fábio Berbert de Paula em 18/04/2020

[ Hits: 12.412 ]

Blog: https://fabio.automatizando.dev

 


Lendo arquivos Markdown no terminal (*.md)



Markdown é um formato de texto mesclado com convenções HTML muito utilizado em repositórios Git. Por exemplo, quase todo repositório Git possui um "README.md". Quando você o abre pelo site GitHub, o formato fica lindo, pois o site interpreta as marcações e formata o texto na sua tela.

Mas já tentou abrir um README.md no terminal do Linux? A tela fica extremamente poluída, misturando tags markdown com texto.

Nesta dica, irei demonstrar como ler arquivos Markdown formatados no terminal. Para a façanha, precisaremos de dois programas, o Pandoc e Lynx. Se não os tiver, instale-os:

sudo apt install pandoc lynx

Pandoc é um conversor genérico de arquivos de markup dos mais variados formatos, pode pode exemplo converter um .md para .txt ou .html e por aí vai. Tem suporte inclusive a arquivos EPub, ODT dentre outros. Dê uma conferida no manual do Pandoc para uma lista mais detalhada:

man pandoc

Já o Lynx dispensa comentários, é um famoso navegador em modo texto para Linux.

Então vamos ao que interessa. Supondo que você está no diretório do teu projeto e quer ler o arquivo README.md. No terminal execute:

pandoc README.md | lynx -stdin

Também é possível ler arquivos remotos. No exemplo abaixo, irei ler o README.md do repositório do Node.js, no caso de arquivos remotos houve a necessidade de forçar o tipo de arquivo de entrada no Pandoc com "-f markdown":

pandoc -f markdown https://raw.githubusercontent.com/nodejs/node/master/README.md | lynx -stdin
Linux: Lendo arquivos Markdown no terminal (*.md)
Também é possível criar um comando para automatizar a leitura. Edite teu arquivo ~/.bash_profile e adicione o seguinte conteúdo:

lermd() {
   pandoc -f markdown $1 | lynx -stdin
}

Reinicie a sessão de usuário ou recarregue as configurações:

source ~/.bash_profile

E em seguida:

lermd README.md

Espero ter ajudado!

Outras dicas deste autor

Pingendo - Crie um layout para o teu site em 5 minutos!

Vim - apagar linhas vazias

Mapeando teclas de modo visual no VIM

Como instalar o repositório do DBeaver no Ubuntu

Como personalizar o thumbnail de seu site no Facebook

Leitura recomendada

Backup e restore das regras de ACLs

Linux avançado: Controle de inicialização em Sabayon Linux

Atualizando a BIOS de máquinas virtuais baseadas em KVM/QEMU

Samba - Erros que podem ocorrer durante o logon do cliente

Criando imagens com IA via terminal

  

Comentários

Nenhum comentário foi encontrado.



Contribuir com comentário