Skip to content

📝 Uso para usuários criarem Docs(artigos) de seus projetos ou produtos! (Mas devem falar que usaram a Pudding Docs.)

License

Notifications You must be signed in to change notification settings

umastrodev12/Pudding-Docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🍮Pudding Docs🍮

📝 Uso para usuários criarem Docs(artigos) de seus projetos ou produtos! (Mas devem falar que usaram a Pudding Docs.)


🚀 Sobre o Pudding Docs

O Pudding Docs foi criado para ser uma solução simples, flexível e de código aberto para gerar documentação técnica e artigos para os seus projetos e produtos. Com foco na clareza e facilidade de uso, ele permite que desenvolvedores e criadores de conteúdo publiquem guias e tutoriais de alta qualidade.

⚙️ Instalação e Uso

O Pudding Docs não exige gerenciadores de pacotes ou ambientes complexos, tornando o uso muito simples.

Passo 1: Clonar o Repositório

git clone [https://github.com/umastrodev12/Pudding-Docs.git](https://github.com/umastrodev12/Pudding-Docs.git)
cd Pudding-Docs

Passo 2: Criar/Editar a Documentação

Adicione ou edite seus arquivos de documentação (geralmente arquivos Markdown .md ou HTML) na pasta designada pelo seu sistema.

🤝 Como Contribuir

Fico muito feliz com o seu interesse em melhorar o Pudding Docs! Contribuições são sempre bem-vindas, seja em código, ideias, relatórios de bugs, ou melhorias na documentação.

Para contribuir:

  1. Faça um Fork deste repositório.
  2. Crie um novo Branch (git checkout -b feature/minha-melhoria).
  3. Faça suas alterações e Commit (git commit -m 'feat: adiciona nova funcionalidade X').
  4. Envie suas mudanças e abra um Pull Request (PR).

⚖️ Licenciamento

O projeto Pudding Docs utiliza um modelo de licenciamento duplo para separar o código-fonte da documentação/conteúdo que ele publica.

Código-Fonte (Templates, Scripts, Configurações)

O código que compõe o gerador de documentação e seus templates está licenciado sob a Apache License 2.0.

Você é livre para usar este código, modificá-lo e distribuí-lo, até mesmo em projetos de código fechado/proprietários, desde que mantenha a atribuição e os avisos de licença originais.

Consulte o arquivo LICENSE para o texto completo.

Conteúdo/Documentação (Artigos, Guias, Textos)

Os artigos, guias e qualquer texto de documentação escritos e publicados usando o Pudding Docs podem ser copiados e reutilizados livremente.

Requisito de Atribuição:

Qualquer pessoa que use, compartilhe ou contribua com o conteúdo deve obrigatoriamente citar o Pudding Docs como a fonte original. O objetivo é garantir que a origem deste trabalho seja sempre reconhecida.

Pudding Docs 🍮

Todos os Direitos reservados. Pudding Docs usa a Licença Apache 2.0 License.

About

📝 Uso para usuários criarem Docs(artigos) de seus projetos ou produtos! (Mas devem falar que usaram a Pudding Docs.)

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published