Ossus

オッスス

Ossus は、次のことに重点を置いたドキュメント サイトを構築するためのフレームワークです。

• シンプル: Ossus を使用すると、1 行 ( create-ossus ) で起動して実行できるようになり、開発作業に手間をかけることなくマークダウンの記述を開始できます。
• カスタマイズ可能: Ossus には、オーバーライドできる広範なテーマ変数を備えたレイアウト用の事前構築済みコンポーネントが付属しています。 Ossus もコンポーネント ベースであるため、任意のレイアウト コンポーネントを独自のものに置き換えて、サイトをフル活用することができます。
• スケーラブル: Ossus は大規模なプロジェクトを中心に設計されており、拡張可能なアーキテクチャを備えているため、どんな規模のプロジェクトでも安心して使用できます。

で構築

• Next.js : Ossus は Next.js の上に構築されており、強力な SSR と静的サイトのエクスポートを提供します。
• React : Ossus は React で構築されているため、UI の構築に関する知識はすべて転送されます。
• Markdown : Ossus はマークダウン ファイルを JSX にレンダリングするため、各ページをコーディングしなくてもサイトの見栄えがよくなります。

インストール

Ossus は 3 つのパッケージで構成されています。

• ossus
• ossus-components
• ossus-scripts

3 つはすべて、NPM 上のパッケージとして利用できます: npm install --save ossus ossus-components ossus-scripts ;

また、使用するディレクトリでnpx create-ossus実行するだけで、1 つのコマンドで Ossus をセットアップできるスターター スクリプトも提供しています。

詳細については、ドキュメントをご覧ください。

貢献する

CDK Global のニーズに完全に適合するフレームワークが見つからなかったため、Ossus を構築しました。私たちは、他の人も私たちが持っている価値をそこから得られることを願っており、コミュニティからの貢献を歓迎します。

行動規範

私たちは、すべての貢献者が遵守することを期待する行動規範を採用しました。このコミュニティの一部として何が許可されているかを理解するために、投稿する前に行動規範をお読みください。

ライセンス

Ossus は MIT ライセンスを取得しています