Erstellen Sie ein einfaches Markdown-Wiki mit Torchpad

Wikis eignen sich hervorragend für die Zusammenarbeit bei Informationen, sei es für Ihre interne Dokumentation oder eine öffentliche Website oder ein Verzeichnis wie Wikipedia. Das einzige Problem ist, dass Wikis oft kompliziert zu erstellen und zu verwenden sind, wie in unserem Tutorial zum Erstellen Ihres eigenen Wikis deutlich wurde. Sie verwenden eine ungewöhnliche Auszeichnungssprache in einer oft datierten Benutzeroberfläche. Es ist alles andere als überraschend, dass es schwer ist, Menschen dazu zu bringen, sich an Wikis zu beteiligen.

So viele Content-Management-Systeme arbeiten heute mit Markdown, der einfachen Textauszeichnungssprache, die leicht in HTML konvertiert werden kann. Es ist eine wesentlich einfachere Art, formatierten Text zu schreiben. Torchpad nutzte die Einfachheit von Markdown und kombinierte es mit der Leistung eines Wikis, um eine weitaus einfachere Wiki-Engine zu erstellen.

In diesem Lernprogramm erfahren Sie alles, was Sie benötigen, um ein eigenes Markdown-Wiki in Torchpad zu erstellen und Ihr Team mit einem einfach zu bedienenden Wiki zusammenarbeiten zu lassen.

Seiten erstellen

Wenn Sie sich bei einem Torchpad-Konto angemeldet haben, wird automatisch ein neues Wiki mit einem Namen erstellt, der auf Ihrer E-Mail-Adresse basiert. Sie sehen dann die Startseite für Ihr Wiki.

Torchpad erstellt eine Beispiel-Homepage.

Fügen Sie Ihrem Wiki eine neue Seite hinzu, indem Sie auf klicken Neue Seite Schaltfläche oben links im Bildschirm. Geben Sie im angezeigten Blatt den Namen Ihrer neuen Seite in das Feld ein Seitenname Feld. Für jetzt verlassen Sie die Dir Pfad Feld leer und klicken Sie auf Erstellen.

Geben Sie einen Namen für Ihre neue Seite ein.

Die neue Seite, die Sie gerade erstellt haben, ist bis auf den von Ihnen angegebenen Titel leer. Drücke den Bearbeiten Klicken Sie oben rechts auf die Schaltfläche, um mit dem Hinzufügen von Inhalt zu beginnen, und Sie sehen die Bearbeitungsansicht für diese Seite.

Die Bearbeitungsansicht enthält alle Werkzeuge, die Sie benötigen.

In der Bearbeitungsansicht können Sie neben den Zusätzen von GitHub-Flavoured Markdown jede normale Markdown-Syntax verwenden. Mit den Schaltflächen oben können Sie schnell die erforderlichen Symbole für Kopfzeilen, Listen und Hervorhebungen einfügen.

Sie können einige Tastenkombinationen verwenden, die in den entsprechenden Schaltflächen angezeigt werden. Speichern Sie Ihre Änderungen mit Befehl-S, und beenden Sie die Bearbeitungsansicht mit Befehl-B. Drücken Sie Befehl-D So können Sie eine Vorschau anzeigen, wie die Seite in ihrem aktuellen Status aussehen wird. Dies ist hilfreich, wenn Sie überprüfen möchten, ob der Markdown wie beabsichtigt interpretiert wird. Wenn Sie sich nicht in der Bearbeitungsansicht befinden, drücken Sie Befehl-E um es einzugeben.

Erstellen Sie Seiten in Ordnern

Sie können auch Seiten in Ordnern hinzufügen, wenn Sie Seiten gruppieren oder Seiten-URLs mit mehreren Teilen angeben möchten. Um dies zu tun, klicken Sie auf Neue Seite, Fügen Sie den gewünschten Pfad für die Seite in hinzu Dir Pfad Feld. Zum Beispiel, wenn Sie möchten, dass sich die Käse-Seite unter befindet / Lebensmittel / Milchprodukte / Käse, Geben Sie "Cheese" in die Seitenname und "Food / Dairy" in der Dir Pfad Feld.

Ordner können beliebig tief verschachtelt werden.

Klicken Erstellen Wenn Sie die neue Seite erstellen möchten, wird die neue Seite in der angegebenen Ordnerstruktur angezeigt.

Fügen Sie Links zwischen Seiten hinzu

Beim Bearbeiten einer Seite in Torchpad gibt es einige zusätzliche Funktionen, die Sie nicht im Standard-Markdown ausführen können. Am wichtigsten ist, dass es eine spezielle Syntax für das Erstellen eines internen Links gibt (einen Link zu einer anderen Seite im selben Wiki)..

Um auf eine andere Seite zu verweisen, umgeben Sie den Namen der Seite in zwei eckige Klammern wie folgt: [[Seitenname]]. Dadurch wird automatisch der Link für Sie erstellt, anstatt die gesamte URL suchen zu müssen, um sie in einen Markdown-Link zu setzen.

Wenn Sie auf eine Seite verlinken möchten, aber als Link einen anderen Text anzeigen möchten, können Sie dies auch tun. Fügen Sie einfach den Text ein, den Sie anzeigen möchten, gefolgt von einem Pipe-Zeichen und dann dem Namen der Seite: [[Anzuzeigender Text | Seitenname]].

Sie müssen keine langen URLs finden, um auf Seiten zu verlinken.

Wenn Sie die Seite besuchen, wird angezeigt, dass der Link den Text vor der Pipe anzeigt, jedoch auf die nach der Pipe benannte Seite.

Links müssen nicht den Namen der Seite anzeigen, auf die sie verlinkt sind.

Bilder zu Seiten hinzufügen

Bilder können zu jeder Seite hinzugefügt werden, genau wie bei normalem Markdown. Torchpad hostet die Bilder jedoch auch für Sie, wenn sie nicht bereits online sind und eine URL angeben. Ziehen Sie das Bild per Drag & Drop auf die Seite und es wird auf Torchpad hochgeladen.

Bilder können überall auf einer Seite abgelegt werden.

Nach dem Hochladen wird der Markdown zur Anzeige des Bildes automatisch eingefügt. Der alternative Text wird auf den Dateinamen des Bildes gesetzt, in das Sie gezogen haben.

Torchpad erledigt die Arbeit beim Einfügen eines Bildes.

Fügen Sie Code und Mathematik zu Seiten hinzu

Um einer Seite eine Codeliste hinzuzufügen, geben Sie einfach drei Backticks in die Zeilen unmittelbar vor und nach dem Code ein.

Betten Sie etwas Code in Ihre Seite ein.

Auf der Live-Seite wird der Code in eine geeignete Schriftart geändert und das Hervorheben der Syntax wird zum leichteren Lesen angewendet.

Code ist viel einfacher in einem separaten Block zu lesen.

Um die Hervorhebung der Syntax an die Sprache anzupassen, in der der Code geschrieben ist, geben Sie den Namen der Sprache direkt nach dem ersten Satz hinterer Häkchen ein, z. B. "Rubin. Dadurch wird sichergestellt, dass der Code richtig hervorgehoben wird und die Schlüsselwörter aus dieser Sprache ausgewählt werden.

Neben Code können Sie mit MathJax mathematische Formeln zu Ihren Seiten hinzufügen. Torchpad behandelt MathJax als Codesprache. Umgeben Sie also Ihren MathJax-Code mit dreifachen Backticks und geben Sie die Sprache als an mathjax.

Verwenden Sie die MathJax-Syntax, um mathematische Formeln einzubetten.

Der MathJax-Code wird wie erwartet auf der Live-Wiki-Seite dargestellt.

Gerenderte Formeln sind viel schöner als einfacher Text.

Sie können MathJax auch inline setzen, genau wie Code in einem Satz inline sein kann. Umgeben Sie dazu den Code mit Dollarzeichen und umgeben Sie ihn Das mit einzelnen Backticks.

Inline MathJax ist wie Inline-Code mit zusätzlichen $ -Symbolen.

Wie zuvor wird der MathJax auf der Live-Seite gerendert, jedoch inline dargestellt.

Inline MathJax ist nützlich für kurze einzeilige Formeln.

Veröffentlichte Seiten veröffentlichen

Wenn Sie mit der Bearbeitung einer Seite fertig sind, möchten Sie sie der Welt zeigen. Um eine Seite zu veröffentlichen, beenden Sie die Bearbeitung und schließen Sie die Bearbeitungsansicht. Klicke auf Entwurf neben der Schaltfläche Bearbeiten und wählen Sie eine der beiden OptionenVeröffentlichen oder Privat einstellen.

Einzelne Seiten können öffentlich oder privat sein.

Auswahl Veröffentlichen macht die Seite für jedermann zugänglich, ohne bei Torchpad angemeldet zu sein. Wählen Privat einstellen um die Seite nur für Personen zugänglich zu machen, die Autoren in Ihrem Wiki sind. Wenn jemand, der nicht Teil Ihres Wikis ist, versucht, auf eine private Seite zuzugreifen, wird die Nachricht "nicht gefunden" angezeigt, als ob die Seite überhaupt nicht vorhanden wäre.

Wiki-Einstellungen

Es gibt einige Einstellungen, die Sie für ein Torchpad-Wiki ändern können. Klicken die Einstellungen links über der Seitenliste, um auf sie zuzugreifen.

Es gibt nicht viele Einstellungen, aber was könnten Sie sonst noch brauchen?

Das Subdomain Mit dieser Option können Sie die URL für Ihr Wiki ändern. Sie können hier alles auswählen, was Sie möchten, und die URL Ihres Wikis wird angezeigt http://what-you-chose.torchpad.com.

Das Wiki-Name Diese Option ändert den Namen des gesamten Wikis. Der von Ihnen gewählte Name wird in der Titelleiste Ihres Wikis angezeigt und muss nicht mit der von Ihnen ausgewählten Subdomain übereinstimmen.

Überprüf den Privates Wiki Ankreuzfeld, um das gesamte Wiki privat zu machen. Das bedeutet, dass nur Mitglieder Ihres Wikis es anzeigen können.

Holen Sie sich schließlich Ihre Google Analytics-ID von der Analytics-Site und fügen Sie sie in die Google Analytics ID Feld. Dadurch werden alle Besuche Ihres Wikis bei Google Analytics protokolliert, um den Datenverkehr zu überwachen.

Mitglieder hinzufügen

Der wichtigste Teil eines Wikis ist die Zusammenarbeit, was bedeutet, dass Sie weitere Personen hinzufügen müssen. Um zu beginnen, klicken Sie auf die Einstellungen, und navigieren Sie dann zu Mitglieder Seite.

Wikis sind für die Zusammenarbeit konzipiert, fügen Sie also weitere Autoren hinzu.

Fügen Sie ein neues Mitglied hinzu, indem Sie ihre E-Mail-Adresse in das Feld eingeben Email Feld. Dann wählen Sie eine Rolle. Ein Inhaber hat volle Administratorrechte, was bedeutet, dass Sie alles ändern können, einschließlich der Einstellungen. Ein Autor kann Seiten bearbeiten, aber keine Einstellungen für das Wiki insgesamt ändern. EIN Beobachter ist einfach jemand, der auf private Seiten des Wikis zugreifen kann.

Mitglieder, die Sie hinzufügen, müssen bereits über ein Torchpad-Konto verfügen. Wenn Sie versuchen, jemanden hinzuzufügen, dessen E-Mail-Adresse nicht bei Torchpad registriert ist, wird ein Fehler angezeigt.

Nach dem Hinzufügen kann ein Mitglied durch Klicken entfernt werden Löschen neben ihrem Namen in der Mitgliederliste.

Exportieren Sie Ihr Wiki

Wenn Sie Ihr Wiki an einem anderen Ort verwenden möchten oder nur eine Sicherungskopie davon erstellen möchten, können Sie die Markdown-Dateien in einem ZIP-Archiv herunterladen. Klicken die Einstellungen, und klicken Sie dann auf Export.

Ein zip-Archiv eignet sich hervorragend als Backup Ihres Wikis.

Es gibt zwei Möglichkeiten, aber weil Torchpad noch in der Beta-Phase ist Zip herunterladen ist verfügbar. Klicken Sie hierauf, um das ZIP-Archiv mit allen Markdown-Dateien herunterzuladen.

In der Zukunft die Git-Klon Diese Option wird verfügbar, sodass Sie das Wiki als Git-Repository herunterladen können, einschließlich des gesamten Bearbeitungsverlaufs für jede Seite.

Fazit

In diesem Tutorial habe ich Ihnen gezeigt, wie Sie Seiten in einem Torchpad-Wiki hinzufügen und bearbeiten, das Wiki veröffentlichen und Mitbearbeiter hinzufügen. Ein Wiki kann auf viele verschiedene Arten nützlich sein, und Torchpad macht es so einfach wie möglich, eines zu erstellen. Es verfügt möglicherweise nicht über alle Funktionen der komplizierteren Tools, aber es ist immer noch möglich, ein großartiges Wiki zu erstellen.