Ossus

奥苏斯

Ossus 是一个用于构建文档站点的框架，其重点是：

• 简单：Ossus 只需一行（ create-ossus ）即可让您启动并运行，并让您开始编写 Markdown，而无需费心处理任何开发工作。
• 可定制：Ossus 附带预构建的布局组件，这些组件具有您可以覆盖的广泛主题变量。 Ossus 也是基于组件的，因此您可以用自己的布局组件替换任何布局组件，以充分掌控您的网站。
• 可扩展：Ossus 围绕大型项目进行设计，并具有可扩展的架构，让任何规模的项目都能轻松应对。

内置

• Next.js ：Ossus 构建在 Next.js 之上，为您提供强大的 SSR 和静态站点导出。
• React ：Ossus 是使用 React 构建的，因此您可以传输有关构建 UI 的所有知识。
• Markdown ：Ossus 将 Markdown 文件渲染为 JSX，这样您的网站就可以看起来很棒，而无需您对每个页面进行编码。

安装

Ossus 由 3 个包组成：

• ossus
• ossus-components
• ossus-scripts

这三个都可以在 NPM 上作为软件包使用： npm install --save ossus ossus-components ossus-scripts ；

我们还提供了一个入门脚本，以便您可以通过一个命令来设置 Ossus，只需在您要使用的目录中运行npx create-ossus即可。

更多信息可以在我们的文档中找到。

贡献

我们构建 Ossus 是因为我们找不到完全符合 CDK Global 需求的框架。我们希望其他人能够从中获得我们所拥有的价值，并且我们欢迎社区的贡献！

行为守则

我们已经制定了行为准则，希望所有贡献者都遵守。请在贡献之前阅读行为准则，以便您了解作为该社区的一部分所允许的行为。

执照

Ossus 获得 MIT 许可