Créer un wiki simple avec Markdown avec Torchpad

Les wikis sont d'excellents moyens de collaborer sur des informations, que ce soit pour votre documentation interne, un site Web public ou un répertoire comme Wikipedia. Le seul problème est que les wikis sont souvent compliqués à créer et à utiliser, comme le montre facilement notre tutoriel sur la construction de votre propre wiki. Ils utilisent un langage de balisage inhabituel dans une interface utilisateur souvent datée. Il n’est pas étonnant qu’il soit difficile d’amener les gens à contribuer aux wikis.

Tant de systèmes de gestion de contenu fonctionnent aujourd'hui avec Markdown, le langage de balisage de texte simple qui est facilement converti en HTML. C'est un moyen beaucoup plus simple d'écrire du texte formaté. Torchpad a utilisé la simplicité de Markdown et l'a combinée à la puissance d'un wiki pour créer un moteur de wiki beaucoup plus simple..

Dans ce tutoriel, vous apprendrez tout ce dont vous avez besoin pour créer votre propre wiki propulsé par Markdown dans Torchpad et pour permettre à votre équipe de collaborer avec un wiki simple à utiliser..

Créer des pages

Une fois que vous avez ouvert un compte Torchpad, un nouveau wiki sera automatiquement créé pour vous avec un nom basé sur votre adresse e-mail. Vous verrez alors la page d'accueil de votre wiki..

Torchpad vous propose un exemple de page d'accueil.

Ajoutez une nouvelle page à votre wiki en cliquant sur le bouton Nouvelle page bouton en haut à gauche de l'écran. Dans la feuille qui apparaît, tapez le nom de votre nouvelle page dans le champ Nom de la page champ. Pour l'instant, quittez le Chemin de dir champ vide, et cliquez sur Créer.

Tapez un nom pour votre nouvelle page.

La nouvelle page que vous venez de créer sera vide, à l'exception du titre que vous lui avez attribué. Clique le modifier bouton en haut à droite pour commencer à ajouter du contenu, et vous verrez la vue modifier pour cette page.

La vue d'édition contient tous les outils dont vous aurez besoin.

En mode édition, vous pouvez utiliser n’importe quelle syntaxe de Markdown normale, ainsi que les ajouts de GitHub-Flavored Markdown. Les boutons situés en haut peuvent être utilisés pour insérer rapidement les symboles nécessaires pour des éléments tels que les en-têtes, les listes et les caractères de soulignement..

Vous pouvez utiliser quelques raccourcis clavier, qui sont affichés dans les boutons auxquels ils correspondent. Enregistrez vos modifications avec Command-S, et quittez la vue d'édition avec Command-B. presse Commande-D pour prévisualiser l’aspect actuel de la page, ce qui est utile pour vérifier si le Markdown sera interprété comme prévu. Si vous n'êtes pas en mode édition, appuyez sur Command-E pour y entrer.

Créer des pages dans des dossiers

Vous pouvez également ajouter des pages dans des dossiers si vous souhaitez regrouper des pages ou donner des URL de pages comportant plusieurs parties. Pour ce faire, lorsque vous cliquez sur Nouvelle page, ajoutez le chemin que vous voulez pour la page dans le Chemin de dir champ. Par exemple, si vous souhaitez que la page Fromage soit située à / Alimentation / Laiterie / Fromage, tapez “Cheese” dans le Nom de la page domaine "aliments / produits laitiers" dans le Chemin de dir champ.

Les dossiers peuvent être imbriqués aussi profondément que vous le souhaitez.

Cliquez sur Créer pour créer la nouvelle page, et vous verrez la nouvelle page répertoriée dans la structure de dossiers que vous avez spécifiée.

Ajouter des liens entre les pages

Lorsque vous modifiez une page sur Torchpad, vous pouvez effectuer quelques opérations supplémentaires qui ne figurent pas dans Markdown. Plus important encore, il existe une syntaxe spéciale pour créer un lien interne (un lien vers une autre page du même wiki).

Pour créer un lien vers une autre page, entourez le nom de la page entre deux crochets, comme suit: [[Nom de la page]]. Cela créera automatiquement le lien pour vous, au lieu d'avoir à trouver l'URL complète à mettre dans un lien Markdown..

Si vous souhaitez créer un lien vers une page, mais que le lien contient un texte différent, vous pouvez également le faire. Il suffit de placer le texte que vous souhaitez afficher en premier, suivi d'un caractère de canal puis du nom de la page, comme suit: [[Texte à afficher | Nom de la page]].

Pas besoin de trouver de longues URL pour lier des pages.

Lorsque vous visitez la page, vous verrez que le lien affiche le texte avant le tuyau, mais des liens vers la page nommée d'après le tuyau..

Les liens n'ont pas à afficher le nom de la page à laquelle ils renvoient.

Ajouter des images aux pages

Les images peuvent être ajoutées à n'importe quelle page, comme avec Markdown, mais Torchpad les hébergera également si elles ne sont pas déjà en ligne avec une URL à spécifier. Glissez-déposez l'image sur la page et elle sera téléchargée sur Torchpad..

Les images peuvent être déposées n'importe où sur une page.

Une fois qu'elle est téléchargée, le Markdown pour afficher l'image sera inséré automatiquement. Le texte alternatif sera défini sur le nom de fichier de l'image que vous avez fait glisser.

Torchpad fait tout le travail lors de l'insertion d'une image.

Ajouter du code et des maths aux pages

Pour ajouter une liste de codes à une page, tapez simplement trois backticks sur les lignes immédiatement avant et après le code..

Intégrez du code dans votre page.

Sur la page en direct, le code sera remplacé par une police appropriée et la surbrillance de la syntaxe sera appliquée pour faciliter la lecture..

Le code est beaucoup plus facile à lire dans un bloc de style séparé.

Pour modifier la coloration syntaxique afin qu'elle corresponde à la langue dans laquelle le code est écrit, saisissez le nom de la langue directement après le premier ensemble de ticks arrière, tel que "rubis. Cela garantira que le code est bien mis en évidence, en récupérant les mots-clés de cette langue..

En plus du code, vous pouvez ajouter des formules mathématiques à vos pages à l'aide de MathJax. Torchpad considère MathJax comme un langage de code. Par conséquent, entourez votre code MathJax de triples tiroirs et spécifiez le langage comme mathjax.

Utilisez la syntaxe MathJax pour incorporer des formules mathématiques.

Le code MathJax sera rendu sur la page de wiki en direct comme prévu.

Les formules rendues sont beaucoup plus agréables que le texte brut.

Vous pouvez également mettre MathJax en ligne, tout comme le code peut être en ligne dans une phrase. Pour ce faire, entourez le code de signes dollar et entourez cette avec des backticks simples.

MathJax en ligne est semblable au code en ligne, avec des symboles $ supplémentaires.

Comme auparavant, MathJax sera rendu sur la page en direct, mais stylé pour s’adapter en ligne.

MathJax en ligne est utile pour les formules courtes d'une ligne.

Publier des pages éditées

Une fois que vous avez terminé de modifier une page, vous aurez envie de la montrer au monde entier. Pour publier une page, terminez la modification et quittez la vue de modification. Cliquer sur Brouillon à côté du bouton Modifier et choisissez soitPublier ou Set Private.

Les pages individuelles peuvent être publiques ou privées.

Choisir Publier rend la page accessible à tous sans être connecté à Torchpad. Choisir Set Private faire en sorte que la page ne soit accessible qu'aux auteurs de votre wiki. Si quelqu'un qui ne fait pas partie de votre wiki tente d'accéder à une page privée, il verra un message "introuvable", comme si la page n'existait pas du tout..

Paramètres du wiki

Il existe quelques paramètres que vous pouvez modifier pour un wiki de Torchpad. Cliquez sur Réglages à gauche, au-dessus de la liste des pages, pour y accéder.

Il n'y a pas beaucoup de paramètres, mais de quoi d'autre pourriez-vous avoir besoin?

le Sous-domaine Cette option vous permet de changer l’URL de votre wiki. Vous pouvez choisir ce que vous voulez ici, et l'URL de votre wiki deviendra http://what-you-chose.torchpad.com.

le Nom du wiki L'option change le nom du wiki entier. Le nom que vous choisissez est affiché dans la barre de titre de votre wiki et ne doit pas nécessairement correspondre au sous-domaine que vous avez choisi..

Vérifier la Wiki privé case à cocher pour rendre le wiki entier privé. Cela signifie que seuls les membres de votre wiki peuvent le voir..

Enfin, récupérez votre identifiant Google Analytics sur le site Analytics et collez-le dans le Identifiant Google Analytics champ. Cela enregistrera toutes les visites de votre wiki dans Google Analytics pour vous permettre de surveiller le trafic..

Ajouter des membres

La partie importante d'un wiki est la collaboration, ce qui signifie que vous devez ajouter plus de personnes. Pour commencer, cliquez sur Réglages, puis naviguez vers le Membres page.

Les wikis sont conçus pour la collaboration, alors ajoutez d'autres auteurs.

Ajouter un nouveau membre en tapant son adresse email dans le champ Email champ. Ensuite, choisissez un Rôle. Un propriétaire dispose de tous les privilèges administratifs, ce qui signifie qu’ils peuvent changer tout ce que vous pouvez, y compris la modification des paramètres Un auteur peut éditer des pages, mais ne peut pas modifier les paramètres du wiki dans son ensemble. UNE observateur est simplement quelqu'un qui peut accéder aux pages privées du wiki.

Les membres que vous ajoutez doivent déjà avoir un compte Torchpad; essayer d’ajouter une personne dont l’adresse e-mail n’est pas enregistrée auprès de Torchpad entraînera une erreur.

Une fois ajouté, un membre peut être supprimé en cliquant sur Retirer à côté de leur nom dans la liste des membres.

Exportez votre wiki

Si vous souhaitez utiliser votre wiki ailleurs ou si vous souhaitez simplement en faire une sauvegarde, vous pouvez télécharger les fichiers Markdown dans une archive zip. Cliquez sur Réglages, puis cliquez sur Exportation.

Une archive zip est idéale comme sauvegarde de votre wiki.

Il y a deux options, mais comme Torchpad est toujours en version bêta, seulement Télécharger Zip est disponible. Cliquez dessus pour télécharger l’archive zip contenant tous les fichiers Markdown..

À l'avenir, le Git Clone Cette option deviendra disponible, vous permettant de télécharger le wiki en tant que référentiel Git, y compris tout l'historique des modifications pour chaque page..

Conclusion

Dans ce didacticiel, je vous ai montré comment ajouter et modifier des pages sur un wiki Torchpad, publier le wiki et ajouter des collaborateurs. Un wiki peut être utile à bien des égards, et Torchpad le rend aussi simple que possible. Il ne possède peut-être pas toutes les fonctionnalités des outils les plus compliqués, mais il est toujours possible de créer un excellent wiki..