igniteui docfx

Зажигание пользовательского интерфейса Docfx Builder

В этом проекте используется Node.js и Gulp в качестве инструмента сборки для ускорения разработки сайта Ignite UI DOCFX для Ignite UI для углового.

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

1. Docfx
2. Node.js
3. Net SDK 6,0 или выше

Начиная

Установка DOCFX

Чтобы установить DOCFX, восстановите его в качестве инструмента DotNet - устанавливает локальные инструменты .NET, которые находятся в области текущего каталога:

dotnet tool restore

ПРИМЕЧАНИЕ . Выполнение npm install также восстанавливает зависимости инструмента DotNet в качестве шага postinstall .

Установка зависимостей node.js:

Если вы используете NPM, запустите:

npm install

Если вы используете пряжу, запустите:

yarn install

Запуск сервера разработки

Процесс сборки зависит от переменной среды NODE_ENV , чтобы иметь возможность установить правильный URL для угловых образцов. Назначьте development , staging или production NODE_ENV .

Вы можете создать файл .env под корнем проекта и установить NODE_ENV , например, присвоив среду.

 NODE_ENV=development

Чтобы запустить сервер, запустите:

Для английского:

npm start -- --lang en

Для японцев:

npm start -- --lang jp

для корейского:

npm start -- --lang kr

Команда берет на себя обязательный аргумент - -lang [en | JP | KR] для обслуживания английской, японской или корейской версии.

Создание статического сайта

Для английского:

npm run build -- --lang en

Для японского:

npm run build -- --lang jp

Для корейского:

npm run build -- --lang kr

Сценарий сборки создает папку, называемую _site в корне соответствующего проекта. Например, для английского, статический сайт живет под en/_site ;

Здание для постановки и производства

Команда сборки очень похожа на вышеупомянутый шаг. Чтобы построить сайт для постановки, запустите:

npm run build-staging --lang en

Команда сборки для постановки:

npm run build-production --lang jp

Использование явного редактора для образцов редактирования в прямом эфире

Атрибут Explicited Editor для элементов вида кода позволяет устанавливать явно живой редактор для указанного образца и поддерживает «CSB» и «StackBlitz» в качестве значений.

 < code-view explicit-editor =" csb " ... > </ code-view > 

 < code-view explicit-editor =" stackblitz " ... > </ code-view > 

Включите TOC -тематические этикетки

Открыть '[en | JP | kr] components toc.yml 'файл для конкретной языковой версии. Каждая тема TOC включает параметры для имени и hREF, а также дополнительный параметр метки. Начиная с версии 3.5.1 Igniteui-Docfx-Template, поддерживаемые этикетки включают «новый», «Обновленный», «Предварительный просмотр» и «Бета». Чтобы добавить желаемую метку, просто укажите его имя и установите его значение true.

Пример:

 - name: Update guide
  href: general/update-guide.md
  updated: true

Складные фрагменты кода

Чтобы сгенерировать и отображать складные фрагменты кода на веб -сайтах документации, выполните следующие действия:

1. Создайте раздел <div> с классом "Fancy-Details".

2. Добавьте элемент <summary> в раздел «Div>».

3. Добавьте сводный текст, представляющий заголовок фрагмента кода в элемент <summary>.

4. Добавьте элемент <code> в раздел «Раздел <div>».

5. Добавьте фрагмент кода в элемент <code>.

6. Пример:

 < div class =" fancy-details " >
    < summary > Example of a successful response body: </ summary >
    < code >
        {
            "id": "{123456}_repo",
            "modified": "2023-02-03T14:07:34.0000000",
            "created": "2023-02-03T14:07:34.0000000",
            "name": "Marketing",
            "user": {
                "id": "{123456}_u ",
                "name": "Teddy Mitkova"
            },
            "dashboardSections": [
                {
                    "id": "{123456}_f",
                    "name": "May"
                }
            ]
        }
    </ code >
</ div >