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 許可