Introdução

opendocs é um modelo que nasceu a partir das necessidades que eu tive com a documentação de projetos open source. A ideia é que você possa usar este modelo para documentar seus projetos de forma simples e bonita.

Inicialmente, construído a partir do site e dos componentes do shadcn/ui, fiz uma série de melhorias e adições para que ele se tornasse um modelo de documentação mais completo para os meus projetos.

Características

• Design bonito e responsivo: O modelo é responsivo e se adapta a qualquer tamanho de tela.
• Componentes prontos para uso: Use os componentes prontos para uso para criar uma documentação bonita e informativa.
• Personalizável: Personalize o modelo para se adequar ao seu projeto.
• Fácil de usar: O modelo é fácil de usar e você pode começar a documentar seu projeto rapidamente.
• Internacionalização: O modelo suporta vários idiomas.
• Sitemap internacionalizado: O sitemap é internacionalizado e você pode adicionar links para diferentes idiomas.
• SEO otimizado: O modelo é otimizado para SEO.
• Pronto para produção: O modelo é pronto para produção e você pode implantá-lo facilmente.
• Tema escuro e claro: O modelo suporta temas escuros e claros.
• Acessível: O modelo procura ser acessível para todos.
• Código aberto: O modelo é de código aberto e você pode contribuir para ele no GitHub.

essas são algumas das características do modelo!

Começando

Para começar a usar o modelo, você pode usar o degit:

npx degit daltonmenezes/opendocs project_name

Depois de clonar o repositório, você pode instalar as dependências e executar o projeto.

cd project_name
pnpm install
pnpm dev

Depois de executar o comando pnpm dev, você pode acessar o modelo em http://localhost:3000.