Lag en enkel Markdown-Powered Wiki med Torchpad

Wikis er gode måter å samarbeide på informasjon, enten det er for din interne dokumentasjon eller et offentlig nettsted eller katalog som Wikipedia. Det eneste problemet er at wikier er ofte kompliserte å lage og bruke, som det var tydelig i vår veiledning om å bygge din egen wiki. De bruker et uvanlig oppslagsspråk inne i et ofte datert brukergrensesnitt. Det er langt fra overraskende at det er vanskelig å få folk til å bidra til wikier.

Så mange innholdsadministrasjonssystemer jobber i dag med Markdown, det enkle tekstoppslagsspråket som enkelt konverteres til HTML. Det er en langt enklere måte å skrive formatert tekst på. Torchpad tok enkelheten til Markdown og kombinerte den med kraften til en wiki for å lage en langt enklere wiki-motor.

I denne opplæringen lærer du alt du trenger for å lage din egen Markdown-drevne wiki i Torchpad og få teamet ditt til å samarbeide med en wiki som er enkel å bruke.

Opprett sider

Når du har registrert deg for en Torchpad-konto, vil en ny wiki automatisk bli opprettet for deg med et navn basert på e-postadressen din. Du vil da se hjemmesiden for wikien din.

Torchpad setter deg opp med et eksempel på hjemmesiden.

Legg til en ny side på wiki ved å klikke på Ny side knappen øverst til venstre på skjermen. I arket som vises, skriv inn navnet på den nye siden i Sidenavn felt. For nå, la Dir sti feltet tomt, og klikk Skape.

Skriv inn et navn for den nye siden.

Den nye siden du nettopp har opprettet vil være tom, lagre for tittelen du ga den. Klikk på Redigere knappen øverst til høyre for å komme i gang med å legge til noe innhold til det, og du vil se redigeringsvisningen for den siden.

Redigeringsvisningen inneholder alle verktøyene du trenger.

I redigeringsvisningen kan du bruke et normalt Markdown-syntaks, sammen med tilleggene fra GitHub-flavored Markdown. Knappene langs toppen kan brukes til å raskt sette inn de nødvendige symbolene for ting som overskrifter, lister og vekt.

Det er noen tastatursnarveier du kan bruke, som vises i knappene de svarer til. Lagre endringene dine med Kommando-S, og gå ut av redigeringsvisningen med Kommando-B. trykk Kommando-D for å forhåndsvise hvordan siden vil se ut i sin nåværende tilstand, noe som er nyttig for å sjekke om Markdown blir tolket på samme måte som du hadde tenkt. Hvis du ikke er i redigeringsvisningen, trykker du på Kommando-E å angi den.

Opprett sider i mapper

Du kan også legge til sider i mapper, hvis du vil gruppere sider sammen eller gi webadresser med flere sider. For å gjøre dette, når du klikker Ny side, Legg til banen du vil ha for siden i Dir sti felt. For eksempel, hvis du vil at Ostsiden skal være plassert på / Mat / Meieri / Cheese, skriv "OST" i Sidenavn feltet og "Mat / Dairy" i Dir sti felt.

Mapper kan nestes så dypt som du vil.

Klikk Skape å opprette den nye siden, og du vil se den nye siden som er oppført i mappestrukturen du angav.

Legg til linker mellom sider

Når du redigerer en side på Torchpad, er det et par ekstra ting du kan gjøre som ikke er i standard Markdown. Viktigst, det er en spesiell syntaks for å opprette en intern link (en lenke til en annen side på samme wiki).

For å koble til en annen side, omgir du navnet på siden i to sett med firkantede parenteser som dette: [[Sidens navn]]. Dette vil automatisk opprette linken for deg, i stedet for å måtte finne hele nettadressen for å sette inn en Markdown-lenke.

Hvis du vil lenke til en side, men vise forskjellig tekst som koblingen, kan du også gjøre det. Bare legg teksten du vil vise først, etterfulgt av et rørkarakter og deretter navnet på siden, slik som dette: [[Tekst som skal vises | Sidenavn]].

Du trenger ikke å finne lange nettadresser for å koble til sider.

Når du besøker siden, vil du se linken viser teksten før røret, men lenker til siden oppkalt etter røret.

Lenker trenger ikke å vise navnet på siden de linker til.

Legg til bilder på sider

Bilder kan legges til en hvilken som helst side, akkurat som med vanlig Markdown, men Torchpad vil også være vert for bildene for deg hvis de ikke allerede er online med en nettadresse for å spesifisere. Dra og slipp bildet på siden, og det blir lastet opp til Torchpad.

Bilder kan bli droppet hvor som helst på en side.

Når den er lastet opp, blir Markdown for å vise bildet automatisk lagt inn. Alt-teksten blir satt til filnavnet til bildet du har slått inn.

Torchpad gjør alt arbeidet når du setter inn et bilde.

Legg til kode og matematikk til sider

For å legge til en kodeoppføring på en side, skriv bare tre backticks på linjene umiddelbart før og etter koden.

Legg inn noen kode på siden din.

På nettsiden vil koden bli endret til en passende skrift, og syntaxutheving vil bli brukt for å gjøre det lettere å lese.

Koden er mye lettere å lese i en separat stilig blokk.

For å endre syntaksuthevingen for å matche språket som koden er skrevet inn, skriv navnet på språket direkte etter det første settet med tilbakekart, for eksempel "rubin. Dette vil sikre at koden er uthevet riktig, plukke opp søkeordene fra det språket.

I tillegg til kode, kan du legge til matematiske formler på sidene dine ved hjelp av MathJax. Torchpad behandler MathJax som kodespråk, så omgitt MathJax-koden med trippelbackticks, og angi språket som mathjax.

Bruk MathJax-syntaksen til å legge inn matematiske formler.

MathJax-koden blir gjengitt på den levende wiki-siden som du forventer.

Renderte formler er mye bedre enn vanlig tekst.

Du kan også sette MathJax inline, samme som kode kan være inline i en setning. For å gjøre dette, omgir koden med dollartegn og surround at med single backticks.

Inline MathJax er akkurat som inline kode, med ekstra $ symboler.

Samme som før, blir MathJax gjengitt på live siden, men stylet for å passe innlinjen.

Inline MathJax er nyttig for korte, en-linjede formler.

Publiser redigerte sider

Når du er ferdig med å redigere en side, vil du vise den til verden. For å publisere en side, fullfør redigering og avslutt redigeringsvisningen. Klikk på utkast ved siden av Rediger-knappen, og velg entenpublisere eller Sett Privat.

Individuelle sider kan være offentlige eller private.

velge publisere gjør siden tilgjengelig for alle uten å være logget inn i Torchpad. Velge Sett Privat for å gjøre siden bare tilgjengelig for personer som er forfattere på wikien din. Hvis noen som ikke er en del av wikien din, prøver å få tilgang til en privat side, vil de se en "ikke funnet" melding, som om siden ikke eksisterte i det hele tatt.

Wiki Innstillinger

Det er noen innstillinger du kan endre for en Torchpad wiki. Klikk innstillinger til venstre, over sidelisten, for å få tilgang til dem.

Det er ikke mange innstillinger, men hva annet kan du trenge?

De underdomene alternativet lar deg endre nettadressen til wikien din. Du kan velge alt du vil ha her, og din wikis URL vil bli http://what-you-chose.torchpad.com.

De Wiki navn alternativet endrer navnet på hele wiki. Navnet du velger vises i tittellinjen på wikien din, og trenger ikke å matche underdomenet du velger.

Undersøk Privat Wiki avkrysningsboks for å gjøre hele wiki-privat. Dette betyr at bare medlemmer av wikien din kan se den.

Til slutt grip din Google Analytics-ID fra Analytics-siden, og lim den inn i Google Analytics-ID felt. Dette vil logge eventuelle besøk på wikien din til Google Analytics, slik at du kan overvåke trafikken til den.

Legg til medlemmer

Den viktige delen av en wiki er samarbeid, noe som betyr at du må legge til flere personer. For å komme i gang, klikk innstillinger, og deretter navigere til medlemmer side.

Wikis er designet for samarbeid, så legg til noen flere forfattere.

Legg til et nytt medlem ved å skrive inn sin e-postadresse i e-post felt. Deretter velger du en rolle. en Eieren har full administrative rettigheter, noe som betyr at de kan endre alt du kan, inkludert endring av innstillinger. en forfatter kan redigere sider, men kan ikke endre innstillinger for wiki som en helhet. EN watcher er bare noen som kan få tilgang til private sider på wiki.

Medlemmer du legger til må allerede ha en Torchpad-konto; Hvis du prøver å legge til noen hvis e-postadresse ikke er registrert med Torchpad, vil det oppstå en feil.

Når en gang er lagt til, kan et medlem fjernes ved å klikke Fjerne ved siden av deres navn i medlemslisten.

Eksporter din Wiki

Hvis du vil ta din wiki andre steder, eller bare vil ha en sikkerhetskopi av det, kan du laste ned Markdown-filene i et zip-arkiv. Klikk innstillinger, og klikk deretter Eksport.

Et zip-arkiv er flott som en sikkerhetskopi av wikien din.

Det er to alternativer, men fordi Torchpad fortsatt er i beta, bare Last ned zip er tilgjengelig. Klikk for å laste ned zip-arkivet som inneholder alle Markdown-filene.

I fremtiden vil Git Clone alternativet vil bli tilgjengelig, slik at du kan laste ned wiki som et git-repository, inkludert all redigeringshistorikk for hver side.

Konklusjon

I denne opplæringen har jeg vist deg hvordan du legger til og rediger sider på en Torchpad wiki, publiser wiki, og legg til samarbeidspartnere. En wiki kan være nyttig på mange forskjellige måter, og Torchpad gjør det så enkelt som det kan være å lage en. Det kan ikke ha alle funksjonene til de mer kompliserte verktøyene, men det er fortsatt mulig å lage en god wiki.