Maak een eenvoudige door Markdown aangedreven Wiki met een Torchpad

Wiki's zijn geweldige manieren om samen te werken aan informatie, of het nu gaat om uw interne documentatie of een openbare website of directory zoals Wikipedia. Het enige probleem is dat wiki's vaak ingewikkeld zijn om te maken en te gebruiken, zoals gemakkelijk te zien was in onze tutorial over het bouwen van je eigen wiki. Ze gebruiken een ongebruikelijke opmaaktaal in een vaak gedateerde gebruikersinterface. Het is helemaal niet verrassend dat het moeilijk is om mensen aan een wiki te laten bijdragen.

Zoveel contentbeheersystemen werken tegenwoordig met Markdown, de eenvoudige tekstopmaaktaal die eenvoudig wordt omgezet in HTML. Het is een veel eenvoudigere manier om opgemaakte tekst te schrijven. Torchpad nam de eenvoud van Markdown en combineerde het met de kracht van een wiki om een ​​veel eenvoudigere wiki-engine te maken.

In deze tutorial leer je alles wat je nodig hebt om je eigen Markdown-powered wiki te maken in Torchpad en je team te laten samenwerken met een wiki die eenvoudig in gebruik is.

Maak pagina's

Zodra u zich hebt aangemeld voor een Torchpad-account, wordt er automatisch een nieuwe wiki voor u gemaakt met een naam op basis van uw e-mailadres. Je ziet dan de startpagina van je wiki.

Met Torchpad kunt u een voorbeeldhomepage instellen.

Voeg een nieuwe pagina toe aan uw wiki door op de te klikken Nieuwe pagina knop in de linkerbovenhoek van het scherm. Typ de naam van uw nieuwe pagina in het blad dat wordt weergegeven Paginanaam veld. Voor nu, verlaat de Dir-pad veld leeg en klik creëren.

Typ een naam voor uw nieuwe pagina.

De nieuwe pagina die je zojuist hebt gemaakt, is leeg, behalve de titel die je hebt opgegeven. Klik op de Bewerk knop in de rechterbovenhoek om aan de slag te gaan met het toevoegen van bepaalde inhoud en je ziet de bewerkingsweergave voor die pagina.

De bewerkingsweergave bevat alle tools die u nodig hebt.

In de bewerkingsweergave kunt u elke normale Markdown-syntaxis gebruiken, samen met de toevoegingen van GitHub-gearomatiseerde markdown. De knoppen aan de bovenkant kunnen worden gebruikt om snel de nodige symbolen in te voegen voor zaken als koppen, lijsten en accenten.

Er zijn een paar sneltoetsen die u kunt gebruiken, die worden weergegeven in de knoppen waarmee ze overeenkomen. Sla uw wijzigingen op met Command-S, en verlaat de bewerkingsweergave met Command-B. druk op Command-D om een ​​voorbeeld te bekijken van hoe de pagina eruit zal zien in de huidige status, wat handig is om te controleren of de Markdown op de door u gewenste manier zal worden geïnterpreteerd. Als u zich niet in de bewerkingsweergave bevindt, drukt u op Command-E om het in te voeren.

Maak pagina's in mappen

U kunt ook pagina's in mappen toevoegen, als u pagina's wilt groeperen of pagina's URL's met meerdere delen wilt geven. Om dit te doen, wanneer u klikt Nieuwe pagina, voeg het gewenste pad toe voor de pagina in de Dir-pad veld. Bijvoorbeeld als u wilt dat de pagina Kaas zich op / Eten / Zuivel / Kaas, typ "Kaas" in de Paginanaam veld, en "Eten / Zuivel" in de Dir-pad veld-.

Mappen kunnen zo diep worden genest als u wilt.

Klik creëren om de nieuwe pagina te maken en ziet u de nieuwe pagina in de mappenstructuur die u hebt opgegeven.

Links tussen pagina's toevoegen

Bij het bewerken van een pagina op Torchpad zijn er een aantal extra dingen die u kunt doen die niet in standaard Markdown zijn. Het belangrijkste is dat er een speciale syntaxis is voor het maken van een interne link (een link naar een andere pagina op dezelfde wiki).

Om naar een andere pagina te linken, omgeeft u de naam van de pagina in twee sets vierkante haken zoals deze: [[Paginanaam]]. Hierdoor wordt de koppeling automatisch voor u gemaakt, in plaats van de volledige URL te vinden die in een Markdown-koppeling moet worden geplaatst.

Als u naar een pagina wilt linken, maar andere tekst als de link wilt weergeven, kunt u dat ook doen. Plaats gewoon de tekst die u als eerste wilt weergeven, gevolgd door een pijpteken en vervolgens de naam van de pagina, zoals deze: [[Tekst om weer te geven | Paginanaam]].

U hoeft geen lange URL's te vinden om naar pagina's te linken.

Wanneer u de pagina bezoekt, ziet u dat de koppeling de tekst vóór de pipe weergeeft, maar links naar de pagina die naar de pipe wordt genoemd.

Links hoeven niet de naam van de pagina te bevatten waarnaar ze linken.

Afbeeldingen toevoegen aan pagina's

Afbeeldingen kunnen op elke pagina worden geplaatst, net als bij reguliere markdown, maar Torchpad host ook de afbeeldingen voor u als ze nog niet online zijn met een URL om op te geven. Sleep de afbeelding naar de pagina en upload deze naar Torchpad.

Afbeeldingen kunnen overal op een pagina worden neergezet.

Nadat het is geüpload, wordt de markering voor het weergeven van de afbeelding automatisch ingevoegd. De alt-tekst wordt ingesteld op de bestandsnaam van de afbeelding die u hebt gesleept.

Torchpad doet al het werk bij het invoegen van een afbeelding.

Voeg code en wiskunde toe aan pagina's

Om een ​​codelijst aan een pagina toe te voegen, typ je gewoon drie backticks op de regels direct voor en achter de code.

Sluit wat code in uw pagina in.

Op de live-pagina wordt de code gewijzigd in een geschikt lettertype en wordt de syntaxis gemarkeerd om het gemakkelijker leesbaar te maken.

Code is veel gemakkelijker te lezen in een apart opgemaakt blok.

Als u de syntaxismarkering wilt wijzigen zodat deze overeenkomt met de taal waarin de code is geschreven, typt u de naam van de taal direct na de eerste set back-tikken, zoals 'robijn. Dit zorgt ervoor dat de code op de juiste manier wordt gemarkeerd en dat de zoekwoorden uit die taal worden opgehaald.

Naast code kunt u wiskundige formules toevoegen aan uw pagina's met MathJax. Torchpad behandelt MathJax als een codetaal, dus omring je MathJax-code met drievoudige backticks en specificeer de taal als mathjax.

Gebruik de MathJax-syntaxis om wiskundige formules in te voegen.

De MathJax-code wordt weergegeven op de live wiki-pagina zoals je zou verwachten.

Gesmolten formules zijn veel leuker dan gewone tekst.

Je kunt ook MathJax inline plaatsen, hetzelfde als code kan inline in een zin staan. Om dit te doen, omring de code met dollartekens en surround dat met enkele backticks.

Inline MathJax is net als inline-code, met extra $ -symbolen.

Hetzelfde als voorheen, wordt de MathJax weergegeven op de live-pagina, maar gestyled om inline te passen.

Inline MathJax is handig voor korte formules met één regel.

Publiceer bewerkte pagina's

Zodra u klaar bent met het bewerken van een pagina, wilt u deze aan de wereld laten zien. Als u een pagina wilt publiceren, voltooit u de bewerking en verlaat u de bewerkingsweergave. Klik op Droogte naast de knop Bewerken en kies een van beidePubliceren of Privé instellen.

Individuele pagina's kunnen openbaar of privé zijn.

kiezen Publiceren maakt de pagina toegankelijk voor iedereen zonder bij Torchpad aangemeld te zijn. Kiezen Privé instellen om de pagina alleen toegankelijk te maken voor mensen die auteurs van je wiki zijn. Als iemand die geen deel uitmaakt van je wiki probeert toegang te krijgen tot een privépagina, wordt het bericht 'niet gevonden' weergegeven alsof de pagina helemaal niet bestaat.

Wiki-instellingen

Er zijn een paar instellingen die u kunt wijzigen voor een Torchpad-wiki. Klik instellingen aan de linkerkant, boven de paginalijst, om ze te openen.

Er zijn niet veel instellingen, maar wat kan je nog meer nodig hebben?

De subdomein optie laat je de URL voor je wiki wijzigen. Je kunt hier alles kiezen wat je wilt, en de URL van je wiki zal worden http://what-you-chose.torchpad.com.

De Wiki-naam optie verandert de naam van de hele wiki. De naam die u kiest, wordt weergegeven in de titelbalk van uw wiki en hoeft niet overeen te komen met het subdomein dat u kiest.

Controleer de Private Wiki checkbox om de hele wiki privé te maken. Dit betekent dat alleen leden van uw wiki het kunnen bekijken.

Pak ten slotte uw Google Analytics-ID van de Analytics-site en plak deze in de Google Analytics ID veld. Dit registreert alle bezoeken aan uw wiki aan Google Analytics zodat u het verkeer ernaar kunt volgen.

Leden toevoegen

Het belangrijkste deel van een wiki is samenwerking, wat betekent dat je wat meer mensen moet toevoegen. Klik op om te beginnen instellingen, en navigeer vervolgens naar de leden pagina.

Wiki's zijn ontworpen voor samenwerking, dus voeg nog een aantal auteurs toe.

Voeg een nieuw lid toe door hun e-mailadres in te typen E-mail veld. Kies vervolgens een Rol. Een eigenaar heeft volledige beheerdersrechten, wat betekent dat ze alles kunnen veranderen wat je kunt, inclusief het wijzigen van instellingen. Een schrijver kan pagina's bewerken, maar kan de instellingen voor de wiki als geheel niet wijzigen. EEN waker is gewoon iemand die toegang heeft tot privépagina's van de wiki.

Leden die u toevoegt, moeten al een Torchpad-account hebben; als u probeert iemand toe te voegen waarvan het e-mailadres niet bij Torchpad is geregistreerd, resulteert dit in een fout.

Eenmaal toegevoegd, kan een lid worden verwijderd door op te klikken Verwijderen naast hun naam in de ledenlijst.

Exporteer je Wiki

Als je je wiki ergens anders naartoe wilt nemen, of gewoon een back-up wilt, kun je de Markdown-bestanden downloaden in een zip-archief. Klik instellingen, en klik vervolgens op Exporteren.

Een zip-archief is geweldig als een back-up van je wiki.

Er zijn twee opties, maar omdat Torchpad nog steeds in bèta is Zip downloaden is beschikbaar. Klik hierop om het zip-archief te downloaden met alle Markdown-bestanden.

In de toekomst zal de Git Clone optie zal beschikbaar worden, waardoor je de wiki als een git repository kunt downloaden, inclusief alle bewerkingshistorie voor elke pagina.

Conclusie

In deze zelfstudie heb ik je laten zien hoe je pagina's kunt toevoegen en bewerken op een Torchpad-wiki, de wiki kunt publiceren en bijdragers kunt toevoegen. Een wiki kan op veel verschillende manieren nuttig zijn, en Torchpad maakt het zo eenvoudig als het zou kunnen zijn om er een te maken. Het heeft misschien niet alle functies van de meer gecompliceerde tools, maar het is nog steeds mogelijk om een ​​geweldige wiki te maken.