[8.x] Document `Str::markdown()` and `Str::of()->markdown()` #6797

u01jmg3 · 2021-01-29T17:03:14Z

Documents laravel/framework#36071
Credit to @amberlampsio

Note:

My code examples don't include the trailing \n the converter also appends as shown in the PR tests
Might be worth linking to the converter docs so developers know all the options available to them
Might be worth defining what GitHub Flavored Markdown is versus normal markdown

amberlampsio · 2021-01-29T17:06:08Z

Thank you for doing this!

colinodell · 2021-01-30T14:53:32Z

If you want to link to the full list of options I'd recommend using https://commonmark.thephpleague.com/configuration/ as the URL

u01jmg3 added 3 commits January 29, 2021 16:39

Document Str::markdown()

aaf8a6f

Document Str::of()->markdown()

da9383d

Update examples to include using custom options

9dd9a64

driesvints changed the title ~~Document Str::markdown() and Str::of()->markdown()~~ [8.x] Document Str::markdown() and Str::of()->markdown() Jan 29, 2021

taylorotwell merged commit 9dd9a64 into laravel:8.x Feb 2, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[8.x] Document `Str::markdown()` and `Str::of()->markdown()` #6797

[8.x] Document `Str::markdown()` and `Str::of()->markdown()` #6797

u01jmg3 commented Jan 29, 2021

amberlampsio commented Jan 29, 2021

colinodell commented Jan 30, 2021

[8.x] Document Str::markdown() and Str::of()->markdown() #6797

[8.x] Document Str::markdown() and Str::of()->markdown() #6797

Conversation

u01jmg3 commented Jan 29, 2021

amberlampsio commented Jan 29, 2021

colinodell commented Jan 30, 2021

[8.x] Document `Str::markdown()` and `Str::of()->markdown()` #6797

[8.x] Document `Str::markdown()` and `Str::of()->markdown()` #6797