Cunoașterea paginilor GitHub pagini statice de proiect, rapide

Să vorbim despre paginile GitHub; ce sunt și cum puteți utiliza serviciul în câteva minute pentru a distribui gratuit pagini statice. Să începem!


Ce este

Potrivit lui GitHub, paginile GitHub sunt:

... pagini web publice găzduite liber și ușor de publicat prin intermediul site-ului nostru.

Ce înseamnă asta pentru tine? Aceasta înseamnă găzduirea gratuită și fiabilă a conținutului static. În general, acest lucru a fost creat de GitHub pentru a sprijini proiectele open-source găzduite pe GitHub, oferindu-le un loc pentru a oferi documentație, demo-uri sau orice altă experiență interactivă dată pentru a completa codul din depozit.


Cu toate acestea, paginile GitHub pot fi utilizate pentru o varietate de proiecte și deja acceptă Jekyll (un generator de site static, puternic, bazat pe Ruby). Deci, să învățăm cum să o folosim!


Înainte de a începe

Va trebui să vă înscrieți pentru un cont GitHub înainte de a începe să utilizați paginile GitHub. Pentru a beneficia de cele mai multe beneficii de la GitHub, este foarte recomandat să vă configurați cheile SSH. Practic, instrucțiunile de la această legătură vă permit să conectați în siguranță calculatorul cu contul dvs. GitHub și cu toate depozitele dvs. de pe GitHub. Odată ce ați creat un cont GitHub și v-ați înregistrat cheile, puteți descărca cu ușurință aplicația GitHub pentru Mac sau GitHub pentru Windows, atât oficial susținută de GitHub.

Copie de rezervă - Ce este în lume GitHub?

GitHub este un loc pentru oamenii să-și păstreze codul. Git este un sistem puternic de control al versiunilor, care permite dezvoltatorilor să urmărească modificările aduse codului în incremente, numite comite, și urmărirea diferitelor căi ale unui anumit proiect prin utilizarea acestuia ramuri.


Există o mulțime de caracteristici ale lui Git, și mai multă putere este blocată în GitHub, dar pentru moment vom rămâne focalizați pe paginile GitHub. Dacă doriți să aflați mai multe despre GitHub, consultați Git pentru designeri, precum și Git & GitHub: Ghidul unui începător care include mai multe informații despre cheile SSH, precum și câteva funcții Git de bază care depășesc domeniul Acest articol.


Diferite moduri de utilizare a paginilor GitHub

Există o varietate de moduri în care pot fi utilizate paginile GitHub. Vom începe cu una dintre cele mai rapide căi.

Generatorul automat de pagini al GitHub

Generatorul automat de pagini permite utilizatorilor să-și creeze pagina utilizând Markdown, un limbaj de markup uman care poate fi creat pentru a ajuta creatorii de conținut să producă cu ușurință documente cu un set consistent de linii directoare de marcare.

Deci, cum folosiți Generatorul automat de pagini? În primul rând, veți dori să creați un depozit. Dacă doriți ca repo-ul să indice numele dvs.-username.github.com, creați un repo care să se potrivească cu acel nume. De exemplu, repo meu personal este numit jcutrell.github.com. Pentru a accesa generatorul de site-uri statice, accesați setările repo (accesibile la o adresă URL care urmează formatul https://github.com/username/projectname/settings). Acesta va afișa un editor care este alimentat de un editor de text bogat Markdown. Puteți copia în mod automat în fișierul standard Readme.md sau puteți edita conținutul dvs. la alegerea dvs. În plus, generatorul automat are și un spațiu pentru urmărirea Google Analytics.

Odată ce ați adăugat tot conținutul relevant, puteți trece la selectorul de aspect. Cu mai multe teme de selectat, aceasta este o opțiune excelentă pentru a da imediat utilizatorilor o pagină de destinație fără efort, bazată pe fișierul dvs. Readme, care necesită pur și simplu să vă actualizați documentația (ceva ce ar trebui să faceți deja). Puteți, de asemenea, să trageți aceste pagini de la origine, să le modificați local și apoi să le împingeți înapoi.

Dacă doriți să utilizați aplicația GitHub pentru a controla depozitul dvs. GitHub, iată cum ați putea face acest lucru.

În primul rând, veți dori să instalați aplicația de la mac.github.com sau windows.github.com și urmați instrucțiunile simple de configurare.


Apoi, alegeți un depozit pe care doriți să-l clonați pe computer selectând numele dvs. de utilizator GitHub din stânga și făcând clic Clonează-te la computer.


Apoi, configurați locația și numele pe care doriți să îl clonați ca depozit.


Apoi, alegeți fila de sucursale din stânga și selectați GH-pagini ramificație creată de generator. Apoi, puteți efectua editările la nivel local în locația pe care ați specificat-o anterior.

Odată ce sunteți gata să împingeți câteva modificări pentru a fi live, du-te la schimbări și creați un comitet cu formularul din stânga sus.


În cele din urmă, selectați ramuri fila și faceți clic pe publica în dreapta ramurii paginilor gh. Aceasta va determina toate modificările dvs. angajate în GitHub.


Dacă doriți să utilizați linia de comandă pentru a controla depozitul GitHub, iată cum ați putea face acest lucru.

 git clone [email protected]: nume utilizator / proiect nume.git git checkout gh-pages

Dacă ați generat o pagină de utilizator (în loc de un singur proiect), sucursala principală este filiala de pagini GitHub. Pur și simplu clona proiectul dvs. de utilizator pentru a edita la nivel local.

 git clone [email protected]: nume de utilizator / username.github.com.git git checkout master # aceasta ar trebui deja verificată deja în mod prestabilit

Cu toate acestea, generatorul automat nu poate fi soluția problemei dvs. Poate că v-ați construit deja site-ul în mod static și căutați pur și simplu să îl deplasați undeva.

Construiți-o manual

Această a doua opțiune este la fel de simplă pe cât pare. Pentru a face ca paginile GitHub să funcționeze cu conținut local arbitrar, mai întâi creați depozitul de pe GitHub.

Dacă v-ați decis să utilizați aplicația GitHub, iată cum ați crea propriile pagini manuale.

Selectează Depozitele mele , apoi faceți clic pe săgeata din depozitul în care doriți să creați paginile GitHub cu. Dacă în prezent nu aveți niciun depozit pentru a elimina lucrurile, puteți crea unul din cadrul aplicației.


Dacă creați pagini GitHub utilizând username.github.com, ramura principală este filiala paginilor, astfel încât să puteți merge mai departe și să deschideți proiectul într-un director local, sărind peste crearea fișierului GH-pagini ramură. Dacă creați pagini GitHub pentru un proiect, veți dori să creați o nouă filială numită GH-pagini; faceți clic pe butonul din partea dreaptă a depozitului, apoi faceți clic pur și simplu pe butonul + din partea dreaptă a ramurii actuale.


Aceasta vă va permite să introduceți numele filialei noi.


În mod implicit, noua ramură va avea toate fișierele de proiect actuale, așa că veți dori să eliminați toate fișierele din proiect în timp ce GH-pagini ramura este selectată. (Pentru a fi sigur, asigurați-vă că indicatorul "ramură curentă" indică faptul că vă aflați pe filiera paginilor gh, cu excepția cazului în care creați pagini pentru username.github.com.)


Apoi, puteți crea un site static direct în dosarul proiectului.

Odată ce ați creat site-ul static în dosarul proiectului, veți reveni la aplicația GitHub și veți merge la schimbări în partea stângă. Aceasta va afișa toate modificările pe care le-ați făcut, inclusiv ștergerea fișierelor originale. Creați o comisie completând formularul din stânga sus. Odată ce ați făcut acest lucru, puteți reveni la fila filiale și publica filiala gh-pages (sau filiala principală, dacă creați pagini pentru username.github.com). Acesta este pasul care vă împinge codul la GitHub și inițiază site-ul static de pe server.

De asemenea, puteți clona cu ușurință depozitul prin linia de comandă selectând adresa URL din partea de sus a paginii proiectului și executând următoarea comandă.

 git clone [email protected]: numele de utilizator / proiectulname.git

Apoi, va trebui să creați o nouă filială numită GH-pagini; această ramură trebuie să fie complet goală, de asemenea. Rulați aceste comenzi:

 git checkout - orfan gh-pagini git rm -rf. git commit -am "paginile inițiale se angajează"

(Pentru mai multe informații, consultați documentația oficială).

Acest lucru va trage în jos proiectul într-un folder numit Denumirea proiectului (indiferent de proiectul dvs.) în directorul dvs. curent de lucru și va avea, de asemenea, în mod automat GitHub ca de origine de la distanță. Practic, aceasta înseamnă că puteți crea fișiere și efectua modificări, apoi urmați următoarele comenzi pentru a urmări acele fișiere și modificări și le împingeți la GitHub.

 starea git # recuperează și echoază starea curentă a depozitului; aceasta va afișa fișiere noi și schimbări netracked adăugați git. # aceasta adaugă toate fișierele noi create git commit -am "Aici este comiterea mea inițială" # aceasta creează o comitet pe sucursala dvs. curentă (în mod implicit, sucursala principală) git push origine gh-pages # aceasta împinge filiala gh-pages la GitHub.

Acest proces va fi repetat pe parcursul tuturor iterațiilor site-ului pe măsură ce faceți modificări. Acest lucru funcționează foarte bine, dar dacă vrei să găzduiești un blog static? Se poate spune că cea mai populară platformă statică de blogging, Jekyll, este acceptată în mod implicit de paginile GitHub. (Jekyll a fost construit de un membru al echipei la GitHub.)

Utilizați Jekyll cu paginile GitHub

Pentru a utiliza Jekyll cu paginile GitHub, va trebui mai întâi să creați un site Jekyll la nivel local. Puteți compila local sau puteți permite GitHub să se compileze pentru dvs. Pentru a începe, puteți urma acest ghid despre Octopress, un cadru care abstractează unele dintre funcțiile de bază ale lui Jekyll.

Alternativ, puteți crea un site Jekyll brut. În primul rând, va trebui să instalați bijuteria jekyll. În general, aceasta înseamnă executarea următoarei comenzi:

 gem install jekyll

Dacă aveți RubyGems instalat, acest lucru ar trebui să tragă cea mai recentă lansare stabilă.

Consultați ghidul de utilizare, precum și acest ghid pe NetTuts. Va trebui să creați structura de bază a fișierelor înainte ca Jekyll să poată genera un site. Pentru a te ridica și a alerga rapid, aruncă o privire la Jekyll-Base-ul lui Daniel McGraw, care definește structura de fișier necesară pentru ca Jekyll să genereze un site. De asemenea, am luat câteva momente pentru a crea un script reutilizabil numit jekyll_structure. Urmați instrucțiunile de instalare; dacă nu funcționează pentru dvs., creați manual următoarea structură.


.
| - .gitignore
| - README
| - _config.yml
| --Parteneri
| | - layout.html
| '- post.html
| - _posturi
| '- 1985-10-26-Test-Post.md
'- index.html

Configurația primară pentru Jekyll va fi introdusă în _config.yml fişier. _layouts va păstra planurile care vor fi utilizate la generare.

Odată ce ați creat postări și pagini și le-ați editat ulterior, puteți să le adăugați pur și simplu în depozitul dvs. git și să le angajați, după cum sa explicat anterior:

 adăugați git. git commit-am "Adăugat o postare nouă" git push origine gh-pages # sau git push master de origine pentru username.github.com pagini

Notă: este mult ușor de utilizat cadre ca Octopress sau Jekyll Bootstrap pentru a genera automat mesaje și pagini pentru Jekyll, cu comenzi asemănătoare rake new_post ["Numele postului merge aici"] în loc să creați manual postarea sau fișierele de pagină.


Alte lucruri importante ale notei

Este important să rețineți că depozitele care sunt setate ca private pe GitHub vor crea pagini publice. GitHub a creat această facilitate pentru proiecte pentru a publica cu ușurință documentația; acest lucru este centrat în jurul ideii de deschidere. Site-urile statice găzduite pe GitHub nu vor fi ascunse de nimeni în curând.

Nu vă limitați la designul sau structura predefinită în paginile generate automat de GitHub. Acestea sunt ușor de editat prin simpla tragere a depozitului până la mașina dvs. locală, efectuarea de modificări și depunerea acestora.

Cu cat invata mai mult despre Git si GitHub, cu atat vei fi mai confortabil cu paginile GitHub. Aruncați o privire la acest post pe Treehouse, precum și acest tutorial Tutsplus de la Jeffrey Way despre GitHub pentru designeri.

Dacă doriți să vă redirecționați propriul domeniu către un domeniu GitHub Pages, consultați acest ghid pe pagina de ajutor a lui GitHub pentru a începe. Cine știe - poate puteți să scăpați de furnizorul dvs. personal de găzduire și să mergeți la toate statice!


Concluzie

Paginile GitHub sunt extrem de convenabile pentru utilizare, mai ales când sunt asociate cu alte instrumente precum Jekyll. Învățarea instrumentelor de care depind paginile GitHub vă va ajuta să deveniți un dezvoltator și un designer mai bun și mai valoros și este o modalitate excelentă de a vă prezenta proiectele. În plus, GitHub oferă acest serviciu gratuit tuturor, astfel încât costul pentru a începe este limitat la valoarea timpului pe care îl cheltuiți. Ce mai astepti? Scufundare in!