Я сделал npm, установив html5-шаблон, что значит «тянуть» в README.md? - PullRequest
0 голосов
/ 03 июля 2019

1. Подведите итог проблемы

С этим проектом: html5-шаблон , есть ли README или руководство по началу работы где-нибудь?

Я сделал: $npm install html5-boilerplate и настроил проект IDE, на этом этапе, как мне продолжить?

Понятно node_modules.

Где шаблон?

Копировать ли файлы откуда-то куда-нибудь? Разве это не то, что должна делать установка $ npm? (копировать файлы откуда-то в мой локальный каталог, тогда это шаблон, который я могу использовать?)

Есть ли способ из каталога библиотеки: node_modules/ выполнить команду, которая запустит веб-сервер, чтобы увидеть шаблон?

Это обычно делается? (Запустите команду в node_modules/ для запуска веб-сервера? Обычно это не делается, запускайте команды с каталогом библиотеки.

Должен ли я ... Я даже не знаю, что спросить, как действовать в этот момент.

У меня есть каталог node_modules/ и файл **package-lock.json* из установки

что обычно делать дальше? а дальше? чтобы:

  1. получить полезный шаблон HTML5
  2. сборка (сборка - все, что нужно для заполнения /dist/ каталога
  3. и затем запустить что-нибудь / что-нибудь, чтобы запустить веб-сервер, чтобы увидеть шаблон?

С уважением,

2. Укажите фон, включая то, что вы уже пробовали

  1. Я сделал npm install html5-boilerplate

  2. Я прочитал README.md ,

  3. , а затем зашел на сайт и не смог найти руководство по началу работы

Я не уверен, что извлекает из node_modules то, что вам нужно означает. Какое действие я бы предпринял и в какой форме «тянуть»?

Если я обнаружу, что означает pull , как мне узнать, что мне нужно, а что нет? Я просто хочу минимальный шаблон HTML5 .

Есть ли в шаблонах вещи, которые не нужны? если так почему?

3. Показать код

Я пытаюсь использовать template, но я не вижу шаблон.

Я вижу каталог node_modules/ (у меня есть каталог, содержащий библиотеку), и я не уверен, что мне следует:

  1. иди создай шаблон
  2. и каким-то образом сделать импорт или включить в файлы, которые я создаю, ссылку на файлы здесь.

4. Опишите ожидаемые и фактические результаты, включая любые сообщения об ошибках

Я ожидаю:

  1. запустите команду для извлечения некоторых файлов, то есть шаблон
  2. см. Документацию по началу работы, которая затем предоставит мне команду для запуска
  3. команда запускает веб-сервер и выводит на консоль URL-адрес для перехода в веб-браузере (в отношении шаблона HTML5)

Вместо этого я выбрал каталог библиотеки: node_modules / без объяснения того, как использовать библиотеку, и шаблон отсутствует.

Только эти три вещи Я ожидаю от любого предоставленного веб-шаблона.

1 Ответ

0 голосов
/ 05 июля 2019

Мы уточним некоторые документы. Это странная область для проекта, так как, честно говоря, npm install html5-boilerplate никогда не будет лучшим способом получить проект. Мы добавили поддержку npm и потратили несколько недель на то, чтобы вернуть контроль над пакетом npm, потому что нам было предложено поддерживать его в актуальном состоянии, и мы убедились, что пакет, размещенный на npm, находится под нашим контролем. Мы предлагаем скачать файлы с сайта или проверить проект с Github и работать с файлами напрямую. HTML5 Boilerplate, во многом, это то, с чем вы работаете до того, как в игру вступит git или npm. Это должно быть основой. Единственная разметка в файле, видимая конечным пользователям, -

  <p>Hello world! This is HTML5 Boilerplate.</p>

Что касается вашего конкретного случая, запуск npm install копирует набор статических файлов в вашу папку node_modules. Вы найдете весь проект внутри node_modules/html5-boilerplate/dist/

h5bp directory structure in an npm install

Если вы хотите увидеть файл, вам не нужно запускать веб-сервер, вы можете просто нажать на index.html, и он будет прекрасно работать в браузере. Что касается того, что «тянуть» означает в readme, это просто означает скопировать любые файлы, которые вам нужны из этой папки. Это не относится к команде для запуска.

...