Quotes Readme

View Demo · Report Bug

Features ✨

• Citações dinâmicas no seu README do GitHub
• Personalize sua própria citação

Usage ⚡️

Copie o markdown abaixo e cole no seu Readme do Github.

[![Quotes Readme](https://quotes-readme.vercel.app/api?type=horizontal&theme=dark)](https://github.com/devhonoratoBR/quotes-readme)

Parâmetros

Param	Default	Disponível
type	vertical	horizontal, vertical
border	false	true, false
lang	en	Verifique a tabela de traduções
id	-	1 a 501
width	-	Altura
height	-	Largura
theme	dark	dark, light, catppuccin, catppuccin_latte, catppuccin_frappe, catppuccin_macchiato, catppuccin_mocha, algolia, monokai, dracula, nord, Chartreuse-dark, radical, merko, gruvbox, tokyonight, github, graywhite, moonlight, hackerman
quote	-	Personalize sua citação
author	-	O nome do autor da citação

Linguagens

Sigla	Tradução
ak	Akan
ar	Árabe
br	Português Brasil
cz	Tcheco
da	Dinamarquês
de	Alemão
el	Grego
en	Inglês
es	Espanhol
esp	Esperanto
fi	Finlandês
fr	Francês
hu	Húngaro
ig	Irlandês
is	Islandês
it	Italiano
iw	Hebraico
ja	Japonês
ko	Coreano
lt	Lituano
lv	Letão
my	Malaio
nl	Holandês
no	Norueguês
pl	Polonês
pt	Português Portugual
ro	Romeno
ru	Russo
sr	Sérvio
sv	Sueco
tr	Turco
uk	Ucraniano
zh	Chinês Simplificado

Instalação e Desenvolvimento 🚀

Antes de começar o desenvolvimento, verifique se o Node.js e o npm estão instalados.

Se não estiverem, faça o download do Node.js, que inclui o npm.

Para confirmar que estão instalados corretamente, execute no terminal os comandos:

node -v
npm -v

Instalação das Dependências

Na pasta raiz do projeto, instale as dependências do aplicativo com:

npm install

Execução do Aplicativo

Para iniciar o aplicativo, execute:

node app.js

Script package.json

No arquivo package.json, existe o seguinte:

{
  "scripts": {
    "start": "node app.js"
  }
}

Para iniciar a aplicação em modo de desenvolvimento, use:

npm run start 

Isso executará o app.js.

Como Usar

Param Type

?type={type_value}

Vertical

Esse é o valor padrão, então ele já será aplicado automaticamente se você não especificar um tipo diferente.

[![](https://quotes-readme.vercel.app/api)](https://github.com/devhonoratoBR/quotes-readme)https://quotes-readme.vercel.app/api

[![](https://quotes-readme.vercel.app/api?type=vertical)](https://github.com/devhonoratoBR/quotes-readme)

Horizontal

Use este parâmetro para definir a orientação da imagem como horizontal. Por exemplo, ?type=horizontal.

[![](https://quotes-readme.vercel.app/api?type=horizontal)](https://github.com/devhonoratoBR/quotes-readme)

Param Border

?border={border_value}

O valor padrão é false. Use este parâmetro para habilitar a borda. Por exemplo, ?border=true.

[![](https://quotes-readme.vercel.app/api?border=true)](https://github.com/devhonoratoBR/quotes-readme)

Param Lang

?lang={language_code}.

Use este parâmetro para especificar o idioma. Por exemplo, ?lang=br para Português Brasil.

[![](https://quotes-readme.vercel.app/api?lang=br)](https://github.com/devhonoratoBR/quotes-readme)

Param ID

?id={id_value}

Use este parâmetro para fornecer um ID único para a citação. Por exemplo, ?id=123.

[![](https://quotes-readme.vercel.app/api?id=123)](https://github.com/devhonoratoBR/quotes-readme)

Param Width

?width={width_value}

Use este parâmetro para definir a largura da imagem. Por exemplo, ?width=600.

[![](https://quotes-readme.vercel.app/api?width=600)](https://github.com/devhonoratoBR/quotes-readme)

Param Height

?height={height_value}

Use este parâmetro para definir a altura da imagem. Por exemplo, ?height=400.

[![](https://quotes-readme.vercel.app/api?height=400)](https://github.com/devhonoratoBR/quotes-readme)

Param Theme

?theme={theme_value}

Dark

Esse é o valor padrão, então ele já será aplicado automaticamente se você não especificar um theme diferente.

[![](https://quotes-readme.vercel.app/api)](https://github.com/devhonoratoBR/quotes-readme)

[![](https://quotes-readme.vercel.app/api?theme=dark)](https://github.com/devhonoratoBR/quotes-readme)

Light

Use este parâmetro para definir o theme light. Por exemplo, ?theme=light para aplicar o tema.

[![](https://quotes-readme.vercel.app/api?theme=light)](https://github.com/devhonoratoBR/quotes-readme)

Catppuccin

Use este parâmetro para definir o theme catppuccin. Por exemplo, ?theme=catppuccin para aplicar o tema.

[![](https://quotes-readme.vercel.app/api?theme=catppuccin)](https://github.com/devhonoratoBR/quotes-readme)

Você pode escolher entre diferentes variantes do tema Catppuccin:

• Latte
• Frappe
• Macchiato
• Mocha

Para aplicar uma variante específica, adicione o sufixo desejado ao parâmetro, como ?theme=catppuccin_latte. Veja abaixo alguns exemplos:

Catppuccin Latte

[![](https://quotes-readme.vercel.app/api?theme=catppuccin_latte)](https://github.com/devhonoratoBR/quotes-readme)

Catppuccin Frappe

[![](https://quotes-readme.vercel.app/api?theme=catppuccin_frappe)](https://github.com/devhonoratoBR/quotes-readme)

Catppuccin Macchiato

[![](https://quotes-readme.vercel.app/api?theme=catppuccin_macchiato)](https://github.com/devhonoratoBR/quotes-readme)

Catppuccin Mocha

[![](https://quotes-readme.vercel.app/api?theme=catppuccin_mocha)](https://github.com/devhonoratoBR/quotes-readme)

Algolia

Use este parâmetro para definir o theme algolia. Por exemplo, ?theme=algolia para aplicar o tema.

[![](https://quotes-readme.vercel.app/api?theme=algolia)](https://github.com/devhonoratoBR/quotes-readme)

Monokai

Use este parâmetro para definir o theme monokai. Por exemplo, ?theme=monokai para aplicar o tema.

[![](https://quotes-readme.vercel.app/api?theme=monokai)](https://github.com/devhonoratoBR/quotes-readme)

Dracula

Use este parâmetro para definir o theme dracula. Por exemplo, ?theme=dracula para aplicar o tema.

[![](https://quotes-readme.vercel.app/api?theme=dracula)](https://github.com/devhonoratoBR/quotes-readme)

Nord

Use este parâmetro para definir o theme nord. Por exemplo, ?theme=nord para aplicar o tema.

[![](https://quotes-readme.vercel.app/api?theme=nord)](https://github.com/devhonoratoBR/quotes-readme)

Chartreuse Dark

Use este parâmetro para definir o theme chartreuse dark. Por exemplo, ?theme=chartreuse-dark para aplicar o tema.

[![](https://quotes-readme.vercel.app/api?theme=chartreuse-dark)](https://github.com/devhonoratoBR/quotes-readme)

Radical

Use este parâmetro para definir o theme radical. Por exemplo, ?theme=radical para aplicar o tema.

[![](https://quotes-readme.vercel.app/api?theme=radical)](https://github.com/devhonoratoBR/quotes-readme)

Merko

Use este parâmetro para definir o theme merko. Por exemplo, ?theme=merko para aplicar o tema.

[![](https://quotes-readme.vercel.app/api?theme=merko)](https://github.com/devhonoratoBR/quotes-readme)

Gruv Box

Use este parâmetro para definir o theme gruvbox. Por exemplo, ?theme=gruvbox para aplicar o tema.

[![](https://quotes-readme.vercel.app/api?theme=gruvbox)](https://github.com/devhonoratoBR/quotes-readme)

Tokyo Night

Use este parâmetro para definir o theme tokyonight. Por exemplo, ?theme=tokyonight para aplicar o tema.

[![](https://quotes-readme.vercel.app/api?theme=tokyonight)](https://github.com/devhonoratoBR/quotes-readme)

GitHub

Use este parâmetro para definir o theme github. Por exemplo, ?theme=github para aplicar o tema.

[![](https://quotes-readme.vercel.app/api?theme=github)](https://github.com/devhonoratoBR/quotes-readme)

Gray White

Use este parâmetro para definir o theme graywhite. Por exemplo, ?theme=graywhite para aplicar o tema.

[![](https://quotes-readme.vercel.app/api?theme=graywhite)](https://github.com/devhonoratoBR/quotes-readme)

Moon Light

Use este parâmetro para definir o theme moonlight. Por exemplo, ?theme=moonlight para aplicar o tema.

[![](https://quotes-readme.vercel.app/api?theme=moonlight)](https://github.com/devhonoratoBR/quotes-readme)

Hacker Man

Use este parâmetro para definir o theme hackerman. Por exemplo, ?theme=hackerman para aplicar o tema.

[![](https://quotes-readme.vercel.app/api?theme=hackerman)](https://github.com/devhonoratoBR/quotes-readme)

Param Quote

?quote={quote_value}

Use este parâmetro para persnalizar o texto da citação. Por exemplo, ?quote=Sua Citação.

[![](https://quotes-readme.vercel.app/api?quote=Sua%20Citação)](https://github.com/devhonoratoBR/quotes-readme)

Param Author

?author={author_value}

Use este parâmetro para persnalizar o autor da sua citação personalizada. Por exemplo, ?author=DevHonorato.

[![](https://quotes-readme.vercel.app/api?quote=Sua%20Citação&author=DevHonorato)](https://github.com/devhonoratoBR/quotes-readme)

Para que este parâmetro funcione corretamente, ele deve ser combinado com o parâmetro quote.

Contribuindo 🤝

Contribuições, problemas e solicitações de recursos são bem-vindos!

Sinta-se à vontade para verificar a issues page.

Agradecimentos Especiais ❤

• Inspirado por PiyushSuthar/github-readme-quotes.
• Obrigado skolakoda/programming-quotes-api pelo Quotes JSON.

Mostre seu apoio 🌈

Não se esqueça de dar uma 🌟 se você gostou do projeto!

Autor 🤗

👤 DevHonoratoBR

• Site: https://devhonorato.com.br
• Github: @devhonorato
• LinkedIn: @Felipe Honorato

Feito por DevHonorato com ❤ e Javascript