Docusaurus — это проект, позволяющий легко создавать, развертывать и поддерживать веб-сайты проектов с открытым исходным кодом.
Мало времени? Посмотрите наш 5-минутный урок ⏱️!
Совет : используйте docusaurus.new , чтобы немедленно протестировать Docusaurus на игровой площадке.
Docusaurus построен таким образом, чтобы его можно было запустить за минимальное время. Мы создали Docusaurus для управления процессом создания веб-сайта, чтобы вы могли сосредоточиться на своем проекте.
Docusaurus поставляется с поддержкой локализации через CrowdIn. Расширяйте возможности и расширяйте свое международное сообщество, переводя вашу документацию.
Хотя Docusaurus поставляется с ключевыми страницами и разделами, необходимыми для начала работы, включая домашнюю страницу, раздел документации, блог и дополнительные страницы поддержки, его также можно настроить, чтобы у вас был уникальный сайт.
Используйте CLI инициализации для создания сайта:
npm init docusaurus@latest
Прочтите документацию для получения дополнительной информации.
Мы выпустили Docusaurus, потому что он помогает нам лучше масштабировать и поддерживает множество проектов OSS в Meta. Мы надеемся, что этот проект принесет пользу другим организациям. Мы благодарны за любой вклад сообщества.
Компания Meta приняла Кодекс поведения, которого мы ожидаем от участников проекта. Пожалуйста, прочтите полный текст, чтобы понять, какие действия будут допущены, а какие нет.
Прочтите наше руководство, чтобы узнать о нашем процессе разработки, о том, как предлагать исправления ошибок и улучшения, а также о том, как создавать и тестировать свои изменения в Docusaurus.
Чтобы помочь вам разобраться и ознакомиться с нашим процессом внесения вклада, у нас есть список ошибок, удобных для новичков, которые могут содержать более мелкие проблемы, которые нужно устранить в первую очередь. Это отличное место для начала.
У нас есть несколько каналов для связи:
#general
для тех, кто использует Docusaurus.#contributors
для тех, кто хочет внести свой вклад в ядро Docusaurus.Этот проект существует благодаря всем людям, которые вносят свой вклад. [Способствовать].
Спасибо всем нашим сторонникам! Стать спонсором
Поддержите этот проект, став спонсором. Здесь появится ваш логотип со ссылкой на ваш сайт. Стать спонсором
Docusaurus имеет лицензию MIT.
Документация Docusaurus (например, файлы .md
в папке /docs
) лицензирована Creative Commons.
BrowserStack поддерживает нас, предоставляя бесплатный доступ к открытому исходному коду.
Rocket Validator помогает нам обнаруживать проблемы с HTML-разметкой или доступностью.