2015-05-06 2 views
0

Я создаю новый сайт с нуля. Его файлы (html, js, css, media) скомпилированы из источников, оптимизированы и ... полностью нечитаемы (от человека). Тем не менее, я все же хочу, чтобы это было бесплатное программное обеспечение. Сейчас я просто создал один комментарий только после тега HTML, то естьСсылка на источники веб-сайта в html

<!DOCTYPE html> 
<html> 
<!-- sources and license: git://...... --> 
<head … 

но есть способ, чтобы сделать его более стандарт? Возможно, есть что-то вроде

<head> 
    <meta sources="git://...." /> 

ответ

0

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

<meta name="sources" content="git://...."> 

Это нестандартное и validator.w3.org не будет проверять свой код как действительный HTML5. Это будет работать без проблем, хотя, даже если есть вероятность, что многие не заметят этого, глядя на исходный код, который, кажется, является вашей главной мотивацией для этого.

Стандартный способ включения этой информации заключается в использовании файла README.md в репозитории, учитывая, что вы публикуете свой код в GitHub/Bitbucket/Gitlab или тому подобное и включаете специальные комментарии в начало файлов сценариев , Например, в JavaScript:

/*! 
* This comment will usually not be stripped out by optimizers. 
*/ 

Обратите внимание на !. Вы можете включать комментарии, которые вам больше всего нравятся, но обратите внимание, что любой вид оптимизатора HTML/компрессора/любого и даже плагинов Google PageSpeed ​​просто вычеркивает комментарии как ненужные навороты.

Кроме того, считается, что хорошая практика действительно имеет опубликованный исходный код как можно более удобный для человека. Просто потому, что разработчику нечего было бы судить о том, будет ли ваше программное обеспечение соответствовать ее требованиям, если ему придется распаковывать/деобфискировать/повторно/очищать свой код, просто чтобы сделать головы или хвосты. Это в основном победит цель открытого источника, если источник, который будет открыт, ужасен.

+0

Если я хорошо понимаю, вопрос OP заключается в том, чтобы предоставить читаемый источник, используя минимальную версию в Интернете, при этом максимально четко связывая этот читаемый источник. –

+0

Отсюда мой комментарий о том, что нет стандартного способа ссылки на источники и альтернативы этому. – herrbischoff

Смежные вопросы