Ossus

Ossus

Ossus é um framework para construção de sites de documentação que tem como foco ser:

• Simples : Ossus coloca você em funcionamento com uma linha ( create-ossus ) e permite que você comece a escrever markdown sem ter que se preocupar com qualquer trabalho de desenvolvimento.
• Personalizável : Ossus vem com componentes pré-construídos para layout que possuem extensas variáveis ​​de tema que você pode substituir. Ossus também é baseado em componentes para que você possa substituir qualquer um dos componentes de layout pelo seu próprio para obter poder total sobre seu site.
• Escalável : Ossus foi projetado para grandes projetos e possui uma arquitetura expansível para permitir que projetos de qualquer tamanho se sintam em casa.

Construído com

• Next.js : Ossus é construído sobre Next.js para fornecer SSR poderoso e exportação de site estático.
• React : Ossus é construído com React, então todo o seu conhecimento sobre a construção de interfaces de usuário é transferido.
• Markdown : Ossus renderiza arquivos markdown em JSX para que seu site tenha uma ótima aparência sem que você precise codificar cada página.

Instalação

Ossus é composto por 3 pacotes:

• ossus
• ossus-components
• ossus-scripts

Todos os três estão disponíveis como pacotes no NPM: npm install --save ossus ossus-components ossus-scripts ;

Também fornecemos um script inicial para que você possa configurar o Ossus em um comando, basta executar npx create-ossus no diretório que deseja usar.

Mais informações podem ser encontradas em nossa documentação.

Contribuindo

Construímos o Ossus porque não conseguimos encontrar uma estrutura que atendesse perfeitamente às nossas necessidades na CDK Global. Esperamos que outros possam obter o valor que temos e agradecemos as contribuições da comunidade!

Código de Conduta

Adotamos um Código de Conduta que esperamos que todos os colaboradores cumpram. Por favor, leia o código de conduta antes de contribuir para saber o que é permitido como parte desta comunidade.

Licença

Ossus é licenciado pelo MIT