desafio.md

Desafio 3 - Gerador de Readme

DevChallenge Hacktoberfest 2022

Índice

• Índice
• Desafio
  • Aplicação
  • Objetivo
  • Requisitos
  • Extras
  • Dicas
• Exemplos
• Comunidade

Desafio

Aplicação

Sempre que vamos desenvolver um projeto, a documentação é uma parte super importante e fazer um readme legal faz toda a diferença para que outras pessoas possam entender seu projeto. Porém, fazer um readme do zero pode ser um pouco demorado, então dessa vez você resolveu criar uma ferramenta para te auxiliar nesse processo!

Objetivo

Você deverá criar uma aplicação que gera modelos de cada parte que compoem um readme.

Requisitos

• Criar uma tela com um editor de texto, onde será possível adicionar seu readme em linguagem markdown
• Um menu do lado esquerdo com as opções: cabeçalho, índice e seção principal
• Ao clicar em uma das opções do menu, seu programa deverá adicionar no editor de texto um modelo de texto em markdown.
  Ex: usuário clicou em "cabeçalho", o programa irá inserir no editor um texto como:

## Índice
- [Sobre](#sobre)
  - [Quem Somos](#quem-somos)
  - [Endereço](#endereco)
- [Contato](#contato)

Atenção, caso o usuário clique em outras opções, o texto não deverá subscrever o texto existente e sim inserir logo abaixo.

Extras

• Disponibize um botão para que o usuário possa copiar o conteúdo do texto
• Crie uma opção de preview do readme
• Adicione outras opções ao menu lateral

Dicas

• Nesse desafio você poderá criar o design da forma que preferir, então pode deixar a criatividade agir o/
• Você pode usar como modelo um readme do próprio devchallenge :)

Exemplos

https://readme.so/pt/editor

Comunidade

Caso tenha alguma dúvida sobre os desafios, fique à vontade para pedir ajuda na comunidade do discord

Site: https://www.devchallenge.com.br/