search

sbrl / Pepperminty-Wiki

A wiki in a box
https://peppermint.mooncarrot.space/
Mozilla Public License 2.0
185 stars 22 forks source link

Documentation Request: Pepperminty Page Markup For Dummies #251

Open UnseenAcademical opened 7 months ago

UnseenAcademical commented 7 months ago

As someone who is only just starting to come to grips with frontend web stuff, I mostly am familiar with the MediaWiki/Wikipedia markup methods. Some of those don't work the same in Pepperminty, and I'd like to have a document linked in the documentation explaining how to format things. The lack of a WYSIWYG editor makes it difficult to know exactly what formatting options are available.

virtadpt commented 7 months ago

The easiest way to do that would be to use the Pepperminty Wiki configuration editor to set editing_message to the URL of a Markdown reference site. I use this one: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet

sbrl commented 2 months ago

Hey there! Sorry it's taken so long to reply - life has been hectic recently.

@virtadpt is correct in that Pepperminty Wiki uses Markdown. Pepperminty Wiki should, by default, show a link at the bottom of the form that appears when you click edit that takes you to a Markdown cheatsheet:

image

Markdown Cheatsheet takes you to GitHub's Markdown help (Pepperminty Wiki uses GitHub-flavoured Markdown, or GFM).

Formatting Help takes you to the Formatting Help section of Pepperminty Wiki's inbuilt help page. It documents all the Pepperminty-Wiki Markdown additions that have been implemented to make writing Wiki pages better. This help page is local to your instance, but you can see the same page on the demo instance here: https://starbeamrainbowlabs.com/labs/peppermint/build/index.php?action=help#20-parser-default

Does this help, @UnseenAcademical?