Итак, вы решили начать публиковаться на github

в 23:03, , рубрики: пора валить, пора сваливать, просто пора, управление проектами, Управление сообществом

Что же, добро пожаловать, хош келигиз, барух аба!

Ответ на вопрос — «зачем мне это хотеть?» в обсуждении этой статьи.

Оговорюсь сразу — это вводный курс молодого бойца, не имеющего никакого понятия ни о гите ни о гитхабе. Это неправильный курс, единcтвенная задача которого — преодолеть порог вхождения и дать тот минимальный набор знаний, необходимых для того, что бы затем более опытные и правильные товарищи могли наставлять на путь истинный. Если же вы git-сихан, то не проходите мимо, дайте наставлений в комментах юным падаванам.

Что делаем? Если не зарегистрировались еще — регистрируемся: https://github.com
Авторизуемся, находим в правом верхнем углу такую картинку: Итак, вы решили начать публиковаться на github - 1.
Нажимаем на крестик, выбираем New repository.
Видим такую картинку:
Итак, вы решили начать публиковаться на github - 2

Ничего страшного, заполняем. В repository name — краткое название репы на английском (может и на других языках можно, не проверял).
Description — описание репы, я сюда пишу собственно название статьи. Ставим галочку на Initialize this repository with a README, это говорит гитхабу о том, что в репу надо добавить README.md, который выполняет функции index.html для репы, то есть отображается для посетителя репозитория, если он явно не указал, какой файл хочет посмотреть. Почему md? Потому что markdown, подробности, как подсказывает spmbt, здесь:
help.github.com/articles/markdown-basics
help.github.com/articles/github-flavored-markdown
help.github.com/articles/writing-on-github

Ну что, жмем на большую зеленую кнопку create repository, получаем вот такой экран:

Итак, вы решили начать публиковаться на github - 3

Внизу мы видим содержимое README.md, а сразу над ним — ссылку на этот файл. Жмем на ссылку и попадаем в экран редактирования файла:

Итак, вы решили начать публиковаться на github - 4

Осталось только нажать на кнопочку с изображением карандаша (ручки) в верхнем правом углу панели инструментов. В этом меню можно вносить изменения, не забываем что мы в маркдауне а не в html. Ок. После внесения правок коммитим: Итак, вы решили начать публиковаться на github - 5. Все, вы умеете создавать и редактировать репозиторий на гитхабе!

После того, как разберетесь с маркдаун версткой, придет понимание того, что в одну репу можно класть несколько документов (новый файл создается нажатием крестика справа от названия репы:
Итак, вы решили начать публиковаться на github - 6
), и вообще устраивать сложную иерархию. Это имеет смысл только для циклов статей или как то иначе связанных документов. Я предпочитаю для каждой статьи делать отдельную репу. Читатель, заинтересовавшийся статьей, может форкнуть репу, может отметить звездочкой и все такое. Если в репе много статей, то копируя репу, читатель получит все, что в ней есть, в том числе и то, что его не интересует. То же самое касается и подписчиков — подписавшись на репу из за одной статьи, подписчик будет получать уведомления по всем изменениям всех документов репозитория.

Ок, теперь у нас есть несколько статей (читай репозиториев), как бы нам их собрать в кучу (сделать личный хабик)? Как выяснилось (спасибо гитхаб-юзеру aol-nnov), гитхаб предоставляет простой способ хостить свои пожитки.

Что же. Англоязычновладеющие могут ознакомиться с оригиналом, я же опишу вкратце. Есть особый репозиторий, который автоматически хостится гитхабом как сайт. Для этого достаточно репозиторий назвать ВАШ_ЛОГИН.github.io, создать в нем index.html и закоммитить. После этого он (index.html) становится доступен по адресу ВАШ_ЛОГИН.github.io:

Итак, вы решили начать публиковаться на github - 7

Но помним — тут уже верстка в html, не markdown. Можно ссылаться на другие документы этого же репозитория ссылками типа /путь к документу. Можно ссылаться на документы других своих репозиториев ссылками типа httрs://USER_NAME.github.io/REPO_NAME/путь к документу, но тут есть один нюанс — документ с другой репы публикуется только в том случае, если он есть в ветке gh-pages. Если такого документа в этой ветке нет или же нет самой ветки — выдаст 404. Что такое ветки — ниже будет ссылка на развитие кругозора, а пока же создадим такую ветку, не понимая глубины и широты происходящего, так же, как мы смотрим телевизор, не понимая механизма дифракции электронов на решетке или причин, по которым свободный электрон не поглощает фотон, в отличие от электрона на орбите. Все эти досадные помехи реальности не мешают нам наслаждаться очередной серией Симпсонов.

Ok, что делаем? Создадим ветку gh-pages в той репе, ссылки на документы из которой мы хотим разместить на своем публичном хабе.
То есть, к примеру, у нас есть репа test, и мы хотим что бы some_page.html из этой репы выводился у нас в user_name.github.io.
Идем в репу тест и находим вот эту кнопочку: Итак, вы решили начать публиковаться на github - 8.
Жмем на нее и вводим в поле ввода gh-pages:
Итак, вы решили начать публиковаться на github - 9
Жмем enter, все! Ветка gh-pages создана! Теперь на все файлы репы можно ссылаться, формат ссылки я указывал выше.

Собственно все! Мы научились создавать документ, редактировать и публиковать его. За бортом остались форки, пулл-реквесты и мерджи, но для понимания этих моментов уже необходимо знать основы гита. А тут уже — обещанная ссылка: git book (без паники, на русском). Поймете основы гита — поймете основы гитхаба, ведь гитхаб — это гит с веб-обвесом и хорошо сдобренный community-building плюшками.

Хорошего всем дня! А, да, и напоследок блиц-опрос.

Автор: gonzazoid

Источник

Поделиться новостью

  1. Vitaly:

    Спасибо. Помог!

* - обязательные к заполнению поля