iota wiki

Исследуйте вики

Ошибка отчета · Запросить тему

Оглавление

• О проекте
  • Построен с
• Начиная
  • Предварительные условия
  • Местное развитие
• Внося
• Контакт

О проекте

Вики йота является центральным центром для входа в экосистему йоты. Общественная инициатива по предоставлению актуальной коллекции представлений и дальнейшего чтения о технологии, командах, сообществе и все, что между ними. Таким образом, любой может научиться строить, принимать и общаться с йотой, все в одном пространстве.

Построен с

Вики йота построена с использованием TypeScript, ReactJS и Docusaurus v2.0.

Начиная

Предварительные условия

• git 1.8.2 или выше.
• Node.js 16.10 или выше.
• Современная пряжа включена запуска corepack enable .

Предварительный просмотр локально

Чтобы предварительно просмотреть вики локально, используйте следующие шаги. Более подробные сценарии, см. Предварительные сценарии для справки.

Обратите внимание, что в вики много контента, поэтому в настоящее время первоначальная сборка занимает некоторое время. Усилия предпринимаются, чтобы попытаться сократить время сборки в будущем.

1. Клонировать репозиторий, используя git clone https://github.com/iotaledger/iota-wiki.git и перейдите в каталог с cd iota-wiki .
2. Установите зависимости с yarn .
3. Подготовьте окружающую среду, yarn prepare , это должно быть сделано только один раз.
4. Предварительный просмотр вики с yarn start , он запустит сервер разработки, обслуживающий вики с возможностью горячей перезагрузки, поэтому он обновит контент после внесения любых изменений.

Предварительно сконфигурированные сценарии

Сценарий	Объяснение
prepare	Подготовьте окружающую среду, проверив строительство подмодулей.
start	Запустите сервер разработки, обслуживающий вики, с горячей перезагрузкой при изменениях.
start:section:{section}	Запустите сервер разработки, обслуживающий только раздел вики, с горячей перезагрузкой при изменениях. Доступные разделы build , get-started , learn и maintain .
build	Построить вики. Чтобы построить для производства, проверьте последнюю версию внешней документации, выполнив yarn checkout:remote и установите переменную среды MODE на production .
checkout:remote	Проверьте последнюю версию внешней документации.
generate:api	Создайте доступную документацию API, настроенную через плагин Docusaurus OpenAPI, и компилизируйте документацию из исходного кода.

Внося

IOTA Wiki поддерживается IF, а вклад сообщества всегда приветствуются. Команда DX и связанные с ними команды из того, чтобы рассмотреть все проблемы и вытянуть запросы, размещенные в этом репозитории. Если вы заметили какие -либо ошибки или чувствуете, что чего -то не хватает, не стесняйтесь создавать проблему для обсуждения с командой или напрямую создавать запрос на привлечение с предложениями. Вот базовый рабочий процесс, чтобы открыть запрос на привлечение:

1. Развете этот репозиторий в свою учетную запись и клонируйте его ( git clone https://github.com/<YOUR_USERNAME>/iota-wiki.git )
2. Создайте филиал функции для ваших изменений ( git checkout -b feat/amazing-feature ).
3. Внесите свои изменения и, необязательно, просмотрите их локально.
4. Запустите yarn format и yarn lint и исправьте оставшиеся ошибки и предупреждения.
5. Сделайте свои изменения ( git commit -m 'Add some amazing feature' ).
6. Встаньте свои изменения в свою вилку ( git push origin feat/amazing-feature ).
7. Откройте запрос на притяжение в main ветвь этого репозитория.

Посмотрите на участие в дальнейшем руководстве.

Версии

Чтобы узнать, как вернуть свои документы, прочитайте это руководство.

Онлайн настройка на один клик для внесения

Вы можете использовать Gitpod (бесплатный, онлайн, VS-кодовый IDE) для участия. С одним щелчком он подготовит все, что вам нужно для создания, и внести свой вклад в вики. Просто нажмите на эту кнопку и пропустите шаг 1 сверху.

Контакт

Phylo - Phyloiota - Phylo [Community Dao - Lets Go!]#2233
Jeroen van den Hout - Jlvandenhout - Jvdhout#4402
DRELECTRON - DR -ELECTRON - DRELECTRON#9370
Критическая - Килианлн - Критическое#7111
JSTO - JSTO91 - JSTO#3746