Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation Request: Pepperminty Page Markup For Dummies #251

Open
UnseenAcademical opened this issue Apr 7, 2024 · 2 comments
Open
Labels
Area: Documentation It's got something to do with documentation question Further information is required

Comments

@UnseenAcademical
Copy link

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
Copy link

virtadpt commented Apr 8, 2024

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
Copy link
Owner

sbrl commented Aug 18, 2024

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?

@sbrl sbrl added question Further information is required Area: Documentation It's got something to do with documentation labels Aug 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Documentation It's got something to do with documentation question Further information is required
Projects
None yet
Development

No branches or pull requests

3 participants