Ossus

Оссус

Ossus — это платформа для создания сайтов документации, которая фокусируется на:

• Просто : Ossus позволяет вам начать работу с помощью одной строки ( create-ossus ) и начать писать уценку без необходимости возиться с какой-либо работой разработчиков.
• Настраиваемость : Ossus поставляется с предварительно созданными компонентами для макета, которые имеют обширные переменные темы, которые вы можете переопределить. Ossus также основан на компонентах, поэтому вы можете заменить любой из компонентов макета своим собственным, чтобы получить полную власть над своим сайтом.
• Масштабируемость : Ossus разработан для крупных проектов и имеет расширяемую архитектуру, позволяющую проектам любого размера чувствовать себя как дома.

Построен с

• Next.js : Ossus построен на основе Next.js и обеспечивает мощные возможности SSR и экспорта статических сайтов.
• React : Ossus создан с использованием React, поэтому все ваши знания о создании пользовательского интерфейса переносятся.
• Markdown : Ossus преобразует файлы уценки в 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