Segredos do Github - Variáveis

Segredos do Github

Hoje estarei dando início a uma nova série de posts chamada Segredos do Github. Essa série trará dicas de coisas secretas que vão dar um _up_ na sua forma de utilizar a rede social mais adorada pelos nerds do mundo todo: o Github!

E o primeiro post será sobre… variáveis! Isso mesmo! Sabia que é possível utilizar variáveis nos seus arquivos Markdown?

Vou mostrar como e porque você deveria utilizar!

Imagine que o seu Markdown tem vários links. Vou dar um exemplo do meu repositório do getmodule:

1
2
3
4
5
6
7
8
9
# Get Module
  
> Include local NodeJS modules relative to your root path
  
[![NPM version](https://badge.fury.io/js/getmodule.svg?style=flat)](https://npmjs.org/package/getmodule)
[![Build Status](https://travis-ci.org/fdaciuk/getmodule.svg)](https://travis-ci.org/fdaciuk/getmodule)
[![Coverage Status](https://img.shields.io/coveralls/fdaciuk/getmodule.svg?style=flat)](https://coveralls.io/r/fdaciuk/getmodule?branch=master)
[![Code Climate](https://codeclimate.com/github/fdaciuk/getmodule/badges/gpa.svg?style=flat)](https://codeclimate.com/github/fdaciuk/getmodule)
[![NPM](https://nodei.co/npm/getmodule.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/getmodule/)

Como você pode ver, no início do arquivo README.md, eu tenho alguns badges com links apontando para versão do módulo no NPM, Status do TravisCI, Status do Code Coverage no Coveralls, Code Climate, etc.

Isso acaba ficando bastante verboso no seu arquivo e, se você precisar usar a mesma URL em outro lugar do seu README, terá que repetí-la.

Variáveis

Mas podemos usar um segredo guardado a sete chaves pelos Ninjas do Github, que são as variáveis!

Tá, fala logo, como que usa isso! ¬¬

Calma, vou dizer :P

No final do seu arquivo, você coloca as suas variáveis nesse formato:

1
[nome-da-variavel]: valor-da-variavel

E para usar, só fazer assim:

1
[nome-da-variavel]

No caso do arquivo Markdown acima, aquele trecho de código ficaria assim:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
# Get Module
  
> Include local NodeJS modules relative to your root path
  
[![NPM version][npm-version-image]][npm-version-url]
[![Build Status][travis-image]][travis-url]
[![Coverage Status][coveralls-image]][coveralls-url]
[![Code Climate][codeclimate-image]][codeclimate-url]
[![NPM][npm-image]][npm-url]
  
[npm-version-image]: https://badge.fury.io/js/getmodule.svg?style=flat
[npm-version-url]: https://npmjs.org/package/getmodule
[travis-image]: https://travis-ci.org/fdaciuk/getmodule.svg
[travis-url]: https://travis-ci.org/fdaciuk/getmodule
[coveralls-image]: https://img.shields.io/coveralls/fdaciuk/getmodule.svg?style=flat
[coveralls-url]: https://coveralls.io/r/fdaciuk/getmodule?branch=master
[npm-image]: https://nodei.co/npm/getmodule.png?downloads=true&downloadRank=true&stars=true
[npm-url]: https://nodei.co/npm/getmodule/
[codeclimate-image]: https://codeclimate.com/github/fdaciuk/getmodule/badges/gpa.svg?style=flat
[codeclimate-url]: https://codeclimate.com/github/fdaciuk/getmodule

Da hora não? ;)

Curtiu? Paia? Comente!

Update

Como algumas pessoas comentaram, isso não é algo específico do Github, mas funciona em alguns outros lugares que seguem a especificação do Markdown.

Ou seja: o foco da série é no Github, mas você pode encontrar também outros lugares onde essas dicas também funcionarão :D

Até o próximo post falando sobre os Segredos do Github :D

Sobre o #1postperday: https://blog.da2k.com.br/2014/12/31/um-post-por-dia/

Tem alguma sugestão para os próximos posts do #1postperday? Deixe ela aqui: https://github.com/fdaciuk/fdaciuk.github.io/issues/1