Creați un Wiki Simplu Markdown-Powered cu Torchpad

Wikis sunt modalități excelente de a colabora pe informații, fie că este vorba despre documentația dvs. internă sau despre un site public sau un director public, cum ar fi Wikipedia. Singura problemă este că wiki-urile sunt adesea complicate de a crea și de a folosi, așa cum a fost evident în tutorialul nostru despre construirea propriului wiki. Ei folosesc un limbaj de marcare neobișnuit în interiorul unui UI adesea datat. Nu este deloc surprinzător faptul că este greu să-i atragi pe oameni să contribuie la wiki.

Atât de multe sisteme de gestionare a conținutului funcționează astăzi cu Markdown, limbajul simplu de marcare a textului ușor convertit în HTML. Este o modalitate mult mai simplă de a scrie text formatat. Torchpad a luat simplitatea Markdown și a combinat-o cu puterea unui wiki pentru a face un motor wiki mult mai simplu.

În acest tutorial, veți afla tot ce aveți nevoie pentru a vă crea propriul wiki de tip Markdown în Torchpad și pentru a obține colaborarea echipei dvs. cu un wiki ușor de folosit.

Creați pagini

După ce v-ați înscris pentru un cont Torchpad, va fi creat automat un nou wiki pentru dvs. cu un nume bazat pe adresa dvs. de e-mail. Veți vedea pagina de pornire pentru wiki.

Torchpad-ul vă pune la dispoziție o pagină principală de exemple.

Adăugați o pagină nouă în wiki făcând clic pe Pagina noua în partea din stânga sus a ecranului. În foaia care apare, tastați numele paginii dvs. noi în Numele paginii camp. Pentru moment, părăsiți Dir calea câmpul gol și faceți clic pe Crea.

Introduceți un nume pentru noua dvs. pagină.

Noua pagină pe care tocmai ați creat-o va fi goală, cu excepția titlului pe care l-ați dat. Apasă pe Editați | × butonul din partea dreaptă sus pentru a începe să adăugați conținut și să vedeți afișarea editării pentru acea pagină.

Ecranul de editare conține toate instrumentele de care aveți nevoie.

În vizualizarea de editare, puteți utiliza orice sintaxă Markdown normală, împreună cu adăugările de la GitHub-Flavored Markdown. Butoanele din partea de sus pot fi utilizate pentru a introduce rapid simbolurile necesare pentru lucruri precum anteturi, liste și accentuare.

Există câteva comenzi rapide de la tastatură pe care le puteți utiliza, care sunt afișate în butoanele pe care le corespund. Salvați modificările cu Command-S, și ieșiți din ecranul de editare cu Command-B. presa Command-D pentru a examina ce va arăta pagina în starea sa actuală, ceea ce este util pentru a verifica dacă Markdown va fi interpretat în modul în care intenționați. Dacă nu sunteți în vizualizarea de editare, apăsați Comandă-E să o introduci.

Creați pagini în dosare

De asemenea, puteți adăuga pagini în dosare, dacă doriți să grupați paginile împreună sau să dați adrese URL de pagini cu mai multe părți. Pentru a face acest lucru, când faceți clic Pagina noua, adăugați calea dorită pentru pagină în Dir calea camp. De exemplu, dacă doriți ca pagina Cheese să fie situată la / Alimente / lactate / Brânză, tip "Brânză" în Numele paginii câmp, și "Alimente / lactate" în Dir calea camp.

Dosarele pot fi imbricate la fel de adânc cum doriți.

Clic Crea pentru a crea noua pagină și veți vedea noua pagină listată în structura de directoare pe care ați specificat-o.

Adăugați legături între pagini

Când editați o pagină pe Torchpad, există câteva lucruri suplimentare pe care le puteți face, care nu sunt în standardul Markdown. Cel mai important este că există o sintaxă specială pentru crearea unui link intern (un link către o altă pagină de pe același wiki).

Pentru a vă conecta la o altă pagină, înconjurați numele paginii în două seturi de paranteze pătrate, cum ar fi: [[Nume pagină]]. Acest lucru va crea automat link-ul pentru tine, în loc de a fi nevoie să găsească întreaga URL-ul pentru a pune într-un link Markdown.

Dacă doriți să vă conectați la o pagină, dar să afișați un alt text ca link, puteți face acest lucru. Puneți mai întâi textul pe care doriți să îl afișați mai întâi, urmat de un caracter de țeavă și apoi de numele paginii, după cum urmează: [[Text de afișat | Numele paginii]].

Nu este nevoie să găsiți adrese URL lungi pentru a vă conecta la pagini.

Când vizitați pagina, veți vedea că linkul afișează textul înaintea țevii, dar face legătura cu pagina numită după țeavă.

Link-urile nu trebuie să afișeze numele paginii pe care sunt conectate.

Adăugați imagini în Pagini

Imaginile pot fi adăugate la orice pagină, la fel ca la Markdown, dar Torchpad va găzdui și imaginile pentru dvs. dacă nu sunt deja online cu o adresă URL pe care să o specificați. Trageți și plasați imaginea pe pagină și va fi încărcată în Torchpad.

Imaginile pot fi aruncate oriunde pe o pagină.

Odată ce este încărcat, Markdown pentru afișarea imaginii va fi introdus automat. Textul alt va fi setat la numele fișierului imaginii pe care ați atras-o.

Torchpad face toată munca când introduceți o imagine.

Adăugați codul și matematica în pagini

Pentru a adăuga o listă de coduri pe o pagină, pur și simplu introduceți trei spate pe liniile imediat înainte și după cod.

Încorporați un cod în pagina dvs..

Pe pagina live, codul va fi modificat la un font corespunzător, iar evidențierea sintaxei va fi aplicată pentru a facilita citirea.

Codul este mult mai ușor de citit într-un bloc separat.

Pentru a modifica evidențierea sintaxei pentru a se potrivi limbii în care este scris codul, tastați numele limbii imediat după primul set de căderi înapoi, cum ar fi "rubin. Acest lucru va asigura că codul este evidențiat în mod corespunzător, preluând cuvintele cheie din acea limbă.

Pe lângă cod, puteți adăuga formule matematice la paginile dvs. utilizând MathJax. Torchpad tratează MathJax ca limbă de cod, astfel încât să înconjurați codul MathJax cu backticks triplu și să specificați limba ca mathjax.

Utilizați sintaxa MathJax pentru a încorpora formule matematice.

Codul MathJax va fi redat pe pagina wiki live așa cum v-ați aștepta.

Formulele formate sunt mult mai frumoase decât textul simplu.

De asemenea, puteți pune MathJax în linie, la fel ca și codul poate fi inline într-o propoziție. Pentru a face acest lucru, înconjurați codul cu semne de dolar și înconjoară acea cu spatele unic.

Inline MathJax este la fel ca și codul inline, cu simboluri extra $.

La fel ca și până acum, MathJax va fi redat pe pagina live, dar va fi în formă.

Inline MathJax este util pentru formule scurte, cu o singură linie.

Publicați paginile editate

După ce ați terminat editarea unei pagini, veți dori să o afișați lumii. Pentru a publica o pagină, finalizați editarea și ieșiți din vizualizarea Editare. Click pe Proiect de lângă butonul Editați și alegeți oricare dintre elePublica sau Setați privat.

Paginile individuale pot fi publice sau private.

alegere Publica face ca pagina să fie accesibilă de oricine, fără a fi conectat (ă) la Torchpad. Alege Setați privat pentru a face pagina accesibilă numai persoanelor care sunt autorii pe wiki. Dacă cineva care nu face parte din wiki dvs. încearcă să acceseze o pagină privată, acesta va vedea un mesaj "nu a fost găsit", ca în cazul în care pagina nu există deloc.

Setări Wiki

Există câteva setări pe care le puteți modifica pentru un wiki Torchpad. Clic Setări în stânga, de deasupra listei de pagini, pentru a le accesa.

Nu există multe setări, dar ce altceva ați putea avea nevoie?

 subdomeniu vă permite să modificați adresa URL pentru wiki. Puteți alege orice doriți aici și adresa URL a wiki-ului dvs. va deveni http://what-you-chose.torchpad.com.

 Numele Wiki opțiunea schimbă numele întregului wiki. Numele pe care îl alegeți este afișat în bara de titlu a wiki-ului dvs. și nu trebuie să se potrivească cu subdomeniul pe care îl alegeți.

Verifică Wiki privat pentru a face întregul wiki privat. Aceasta înseamnă că numai membrii wiki-ului dvs. îl pot vedea.

În cele din urmă, apucați ID-ul Google Analytics de pe site-ul Google Analytics și inserați-l în ID-ul Google Analytics camp. Aceasta va loga toate vizitele pe wiki la Google Analytics pentru a vă permite să monitorizați traficul către acesta.

Adăugați membri

Partea importantă a unui wiki este colaborarea, ceea ce înseamnă că trebuie să adăugați mai multe persoane. Pentru a începe, faceți clic pe Setări, și apoi navigați la Membrii pagină.

Wikis sunt concepute pentru colaborare, deci adăugați și alți autori.

Adăugați un membru nou introducând adresa sa de e-mail în E-mail camp. Apoi, alegeți a Rol. Un proprietar are privilegii administrative complete, ceea ce înseamnă că pot schimba orice poți, inclusiv schimbarea setărilor. Un autor poate edita pagini, dar nu poate schimba setările pentru wiki ca un întreg. A Watcher este pur și simplu o persoană care poate accesa paginile private ale wiki-ului.

Membrii pe care îi adăugați trebuie să aibă deja un cont Torchpad; încercarea de a adăuga pe cineva a cărui adresă de e-mail nu este înregistrată la Torchpad va duce la o eroare.

După adăugare, un membru poate fi eliminat făcând clic Elimina alături de numele lor din lista de membri.

Exportați-vă Wiki-ul

Dacă doriți să vă luați wiki în altă parte sau doriți doar o copie de rezervă, puteți descărca fișierele Markdown într-o arhivă zip. Clic Setări, apoi faceți clic pe Export.

O arhivă zip este minunată ca o copie de rezervă a wiki-ului.

Există două opțiuni, dar deoarece Torchpad este încă în beta, numai Descărcați Zip este disponibil. Faceți clic pe acesta pentru a descărca arhiva zip care conține toate fișierele Markdown.

În viitor, Git Clone va deveni disponibilă, permițându-vă să descărcați wiki-ul ca un depozit git, inclusiv toate istoricul modificărilor pentru fiecare pagină.

Concluzie

În acest tutorial, v-am arătat cum să adăugați și să editați pagini pe un wiki Torchpad, să publicați wiki-ul și să adăugați colaboratori. Un wiki poate fi util în multe moduri diferite, iar Torchpad o face la fel de simplu ca și cum ar fi posibil să o faci. Este posibil să nu aibă toate caracteristicile instrumentelor mai complicate, dar este încă posibil să faci un wiki grozav.