Crea un Wiki semplice Markdown-Powered con Torchpad

I wiki sono ottimi modi per collaborare alle informazioni, sia che si tratti della documentazione interna o di un sito Web pubblico o di una directory come Wikipedia. L'unico problema è che i wiki sono spesso complicati da creare e utilizzare, come è facilmente evidente nel nostro tutorial sulla creazione della tua wiki. Usano un linguaggio di marcatura insolito all'interno di un'interfaccia utente spesso datata. Non è sorprendente che sia difficile convincere le persone a contribuire ai wiki.

Così tanti sistemi di gestione dei contenuti oggi funzionano con Markdown, il semplice linguaggio di marcatura del testo che può essere facilmente convertito in HTML. È un modo molto più semplice di scrivere testo formattato. Torchpad ha preso la semplicità di Markdown e combinato con la potenza di una wiki per creare un motore wiki molto più semplice.

In questo tutorial imparerai tutto ciò di cui hai bisogno per creare la tua wiki con Markdown in Torchpad e far sì che il tuo team collabori con una wiki semplice da usare.

Crea pagine

Una volta registrato un account Torchpad, verrà automaticamente creato un nuovo wiki con un nome basato sul tuo indirizzo email. Vedrai quindi la Home page per il tuo wiki.

Torchpad ti imposta con una homepage di esempio.

Aggiungi una nuova pagina al wiki facendo clic sul Nuova pagina pulsante in alto a sinistra dello schermo. Nel foglio che appare, digita il nome della tua nuova pagina nel Nome della pagina campo. Per ora, lascia il Percorso Dir campo vuoto, e fare clic Creare.

Digita un nome per la tua nuova pagina.

La nuova pagina appena creata sarà vuota, tranne per il titolo che hai assegnato. Clicca il modificare in alto a destra per iniziare ad aggiungere alcuni contenuti e vedrai la vista di modifica per quella pagina.

La vista di modifica contiene tutti gli strumenti necessari.

Nella visualizzazione di modifica, puoi utilizzare qualsiasi normale sintassi di Markdown, insieme alle aggiunte di GitHub-Flavored Markdown. I pulsanti nella parte superiore possono essere utilizzati per inserire rapidamente i simboli necessari per elementi come intestazioni, elenchi ed enfasi.

Ci sono alcune scorciatoie da tastiera che puoi usare, che vengono visualizzate nei pulsanti a cui corrispondono. Salva i tuoi cambiamenti con Comando-S, e uscire dalla vista di modifica con Comando-B. stampa Comando-D per vedere in anteprima l'aspetto della pagina nel suo stato attuale, utile per verificare se il Markdown verrà interpretato nel modo desiderato. Se non si è nella visualizzazione di modifica, premere Comando-E per entrarci.

Crea pagine in cartelle

È inoltre possibile aggiungere pagine all'interno di cartelle, se si desidera raggruppare insieme le pagine o fornire URL di pagine con più parti. Per fare questo, quando si fa clic Nuova pagina, aggiungi il percorso che desideri per la pagina in Percorso Dir campo. Ad esempio, se desideri che la pagina di formaggio sia posizionata su / Cibo / Dairy / Formaggi, digita "Formaggio" nel Nome della pagina campo e "Cibo / caseificio" nel Percorso Dir campo.

Le cartelle possono essere nidificate quanto vuoi.

Clic Creare per creare la nuova pagina e vedrai la nuova pagina elencata nella struttura della cartella che hai specificato.

Aggiungi collegamenti tra le pagine

Quando modifichi una pagina su Torchpad, ci sono un paio di cose extra che puoi fare che non sono in Markdown standard. Ancora più importante, c'è una sintassi speciale per la creazione di un collegamento interno (un collegamento ad un'altra pagina sulla stessa wiki).

Per collegare a un'altra pagina, racchiudi il nome della pagina in due serie di parentesi quadre come questa: [[Nome pagina]]. Questo creerà automaticamente il link per te, invece di dover trovare l'intero URL da inserire in un link Markdown.

Se desideri collegare a una pagina, ma visualizza un testo diverso come link, puoi farlo anche tu. Metti solo il testo che desideri visualizzare per primo, seguito da un carattere pipe e poi il nome della pagina, in questo modo: [[Testo da visualizzare | Nome pagina]].

Non c'è bisogno di trovare URL lunghi per collegarsi alle pagine.

Quando visiti la pagina, vedrai che il link mostra il testo prima della pipe, ma i link alla pagina chiamata dopo la pipe.

I collegamenti non devono visualizzare il nome della pagina a cui si collegano.

Aggiungi immagini alle pagine

Le immagini possono essere aggiunte a qualsiasi pagina come con il normale Markdown, ma Torchpad ospiterà anche le immagini per te se non sono già online con un URL da specificare. Trascina e rilascia l'immagine sulla pagina e verrà caricata su Torchpad.

Le immagini possono essere lasciate cadere ovunque su una pagina.

Una volta caricato, il Markdown per la visualizzazione dell'immagine verrà inserito automaticamente. Il testo alternativo verrà impostato sul nome file dell'immagine trascinata.

Torchpad fa tutto il lavoro quando si inserisce un'immagine.

Aggiungi codice e matematica alle pagine

Per aggiungere un elenco di codice a una pagina, è sufficiente digitare tre backtick sulle linee immediatamente prima e dopo il codice.

Incorpora un codice nella tua pagina.

Nella pagina live, il codice verrà modificato in un carattere appropriato e l'evidenziazione della sintassi verrà applicata per semplificare la lettura.

Il codice è molto più facile da leggere in un blocco di stile separato.

Per modificare l'evidenziazione della sintassi in modo che corrisponda alla lingua in cui è scritto il codice, digita il nome della lingua direttamente dopo il primo set di tick indietro, come "rubino. Ciò assicurerà che il codice sia evidenziato in modo corretto, raccogliendo le parole chiave da quella lingua.

Oltre al codice, puoi aggiungere formule matematiche alle tue pagine usando MathJax. Torchpad tratta MathJax come linguaggio in codice, quindi racchiudi il tuo codice MathJax con triplici apici inversi e specifica la lingua come mathjax.

Utilizzare la sintassi MathJax per incorporare formule matematiche.

Il codice MathJax verrà reso nella pagina wiki live come ti aspetteresti.

Le formule renderizzate sono molto più belle del testo normale.

È anche possibile inserire MathJax in linea, come se il codice fosse in linea in una frase. Per fare ciò, circondare il codice con i simboli del dollaro e surround quello con singoli apici inversi.

Inline MathJax è proprio come il codice inline, con simboli $ extra.

Come in precedenza, MathJax sarà renderizzato sulla pagina live, ma disegnato per adattarsi in linea.

Inline MathJax è utile per formule corte a una riga.

Pubblica pagine modificate

Una volta che hai finito di modificare una pagina, ti consigliamo di mostrarla al mondo. Per pubblicare una pagina, terminare la modifica e uscire dalla vista di modifica. Clicca su Bozza accanto al pulsante Modifica e sceglierePubblicare o Imposta privata.

Le singole pagine possono essere pubbliche o private.

scelta Pubblicare rende la pagina accessibile da chiunque senza essere loggata in Torchpad. Scegliere Imposta privata per rendere la pagina accessibile solo alle persone che sono autori sul tuo wiki. Se qualcuno che non fa parte del wiki tenta di accedere a una pagina privata, vedrà un messaggio "non trovato", come se la pagina non esistesse affatto.

Impostazioni Wiki

Ci sono alcune impostazioni che puoi cambiare per un wiki di Torchpad. Clic impostazioni a sinistra, sopra l'elenco delle pagine, per accedervi.

Non ci sono molte impostazioni, ma cos'altro potresti aver bisogno?

Il sottodominio l'opzione ti consente di cambiare l'URL per il tuo wiki. Puoi scegliere tutto ciò che vuoi qui e l'URL del tuo wiki diventerà http://what-you-chose.torchpad.com.

Il Nome Wiki l'opzione cambia il nome dell'intero wiki. Il nome scelto viene visualizzato nella barra del titolo del wiki e non deve corrispondere al sottodominio selezionato.

Controlla il Wiki privato casella di controllo per rendere privato l'intero wiki. Ciò significa che solo i membri della tua wiki possono vederlo.

Infine, prendi il tuo ID Google Analytics dal sito di Analytics e incollalo nel ID di Google Analytics campo. Questo registrerà tutte le visite al tuo wiki su Google Analytics per consentirti di monitorare il traffico verso di esso.

Aggiungi membri

La parte importante di un wiki è la collaborazione, il che significa che devi aggiungere altre persone. Per iniziare, fare clic impostazioni, e quindi navigare verso Utenti pagina.

I wiki sono progettati per la collaborazione, quindi aggiungi altri autori.

Aggiungi un nuovo membro digitando il loro indirizzo email nel E-mail campo. Quindi, scegliere a Ruolo. Un proprietario ha i privilegi amministrativi completi, nel senso che possono cambiare qualsiasi cosa tu possa, inclusa la modifica delle impostazioni. Un autore può modificare pagine, ma non può modificare le impostazioni per il wiki nel suo complesso. UN osservatore è semplicemente qualcuno che può accedere a pagine private del wiki.

I membri che aggiungi devono avere già un account Torchpad; cercando di aggiungere qualcuno il cui indirizzo email non è registrato con Torchpad si tradurrà in un errore.

Una volta aggiunto, un membro può essere rimosso facendo clic Rimuovere accanto al loro nome nell'elenco dei membri.

Esporta il tuo Wiki

Se vuoi portare la tua wiki altrove, o semplicemente volerne una copia di backup, puoi scaricare i file Markdown in un archivio zip. Clic impostazioni, e quindi fare clic Esportare.

Un archivio zip è ottimo come backup della tua wiki.

Ci sono due opzioni, ma perché Torchpad è ancora in beta, solo Scarica Zip è disponibile. Fare clic per scaricare l'archivio zip contenente tutti i file Markdown.

In futuro, il Git Clone l'opzione diventerà disponibile, consentendo di scaricare il wiki come repository git, inclusa tutta la cronologia delle modifiche per ogni pagina.

Conclusione

In questo tutorial, ti ho mostrato come aggiungere e modificare pagine su un wiki Torchpad, pubblicare il wiki e aggiungere collaboratori. Un wiki può essere utile in molti modi diversi, e Torchpad lo rende il più semplice possibile per crearne uno. Potrebbe non avere tutte le funzionalità degli strumenti più complicati, ma è comunque possibile creare un wiki eccezionale.