Ossus

Ossus

Ossus es un marco para crear sitios de documentación que se centra en ser:

• Simple : Ossus lo pone en funcionamiento con una línea ( create-ossus ) y le permite comenzar a escribir Markdown sin tener que preocuparse por ningún trabajo de desarrollo.
• Personalizable : Ossus viene con componentes prediseñados para el diseño que tienen extensas variables temáticas que puedes anular. Ossus también se basa en componentes, por lo que puede reemplazar cualquiera de los componentes de diseño por el suyo propio para obtener pleno poder sobre su sitio.
• Escalable : Ossus está diseñado para proyectos grandes y tiene una arquitectura expandible para permitir que proyectos de cualquier tamaño se sientan como en casa.

Construido con

• Next.js : Ossus está construido sobre Next.js para brindarle SSR potente y exportación de sitios estáticos.
• React : Ossus está construido con React, por lo que se transfiere todo su conocimiento sobre la creación de interfaces de usuario.
• Markdown : Ossus procesa archivos de rebajas en JSX para que su sitio se vea genial sin tener que codificar cada página.

Instalación

Ossus se compone de 3 paquetes:

• ossus
• ossus-components
• ossus-scripts

Los tres están disponibles como paquetes en NPM: npm install --save ossus ossus-components ossus-scripts ;

También proporcionamos un script de inicio para que pueda configurar Ossus con un solo comando, simplemente ejecute npx create-ossus en el directorio que desee usar.

Puede encontrar más información en nuestra documentación.

Contribuyendo

Construimos Ossus porque no pudimos encontrar un marco que se ajustara perfectamente a nuestras necesidades en CDK Global. Esperamos que otros puedan aprovechar el valor que tenemos y agradecemos las contribuciones de la comunidad.

Código de conducta

Hemos adoptado un Código de conducta que esperamos que cumplan todos los contribuyentes. Lea el código de conducta antes de contribuir para saber qué está permitido como parte de esta comunidad.

Licencia

Ossus tiene licencia del MIT