Documentation enhancement: support markdown alerts

[Brackets-Coder]

#2050

This is a simple pull request that adds support for alerts in extension documentation markdown files:

Note

Useful information that users should know, even when skimming content.

Tip

Helpful advice for doing things better or more easily.

Important

Key information users need to know to achieve their goal.

Warning

Urgent info that needs immediate user attention to avoid problems.

Caution

Advises about risks or negative outcomes of certain actions.

Some of the CSS is messy and the rule was poorly designed and I kind of rushed this

[CubesterYT]

Haven't tested yet, but here are some changes I think could be made

[CubesterYT]

I'll test this now.

[CubesterYT]

Seems to work great! (I'm surprised my suggested changes didn't break anything, this was my first time handling that area.)

[CubesterYT]

Now the next step going forward, is removing the tests in Simple3D, and actually go through all documentations and utilizing these new features, and then this PR should be ready

[Brackets-Coder]

Now the next step going forward, is removing the tests in Simple3D, and actually go through all documentations and utilizing these new features, and then this PR should be ready

Must every extension utilize these? I think they would be more efficient in larger extensions like Simple3D and AR but I don't think things like Bitwise or local storage should have them

[CubesterYT]

Must every extension utilize these? I think they would be more efficient in larger extensions like Simple3D and AR but I don't think things like Bitwise or local storage should have them

I meant looking through documentations that actually could utilize these. I know some docs actually have things like notes/important/warnings, etc., and we could update them with these.

[Brackets-Coder]

Seems to work great! (I'm surprised my suggested changes didn't break anything, this was my first time handling that area.)

I'm not surprised, CSS isn't too hard to learn

[Brackets-Coder]

I've added a warning to the "precision mode" performance note in Box2D. I figure the best way to go about including these in documentation is to just go through all the extensions in order one by one

[yuri-kiss]

Other than this it looks good to me

[Brackets-Coder]

okay, the build was failing and I wanted it to fail gracefully, but I'll add the throw. Thanks for clarifying

[Brackets-Coder]

Not sure if I fully understood what you were asking for, but I think this should do it?

[Brackets-Coder]

No, I just broke it.

[Brackets-Coder]

I think this is what you meant

[Brackets-Coder]

@yuri-kiss doing your suggested change always returns an error of match null (even when using a valid alert type) and doing it for the icon accepts incorrect syntax.

[Brackets-Coder]

I understood what to do, but I was a bit busy doing other things but adding the TypeError makes it fail every time even if there isn't an error...

The second image is from Local Storage's documentation, which has NO alerts but it still returns an error...

[Brackets-Coder]

@yuri-kiss it's not working and fails on every documentation page immediately, even if there is no alert. Also fails for alerts done correctly.

[GarboMuffin]

If it looks like the screenshots then I like it, it's cool

[Brackets-Coder]

If it looks like the screenshots then I like it, it's cool

Still have a few issues and things to work out before this is ready to be merged, but I'm abnormally busy with life right now so I'll get around to it whenever I can

[Brackets-Coder]

I've added a comment above the alert icons with a link to the source SVG and fixed the format issues. I'll do the "rest" after I get some "rest"
Really bad pun intended

[Brackets-Coder]

@yuri-kiss the commit I just pushed should make this merge-ready

[yuri-kiss]

Merging :3, great job mate

[Brackets-Coder]

Some things still don't work... attempting to use note types that aren't all caps doesn't throw an error, eg., no warning is passed when doing > [!Note]

[Brackets-Coder]

Some things still don't work... attempting to use note types that aren't all caps doesn't throw an error, eg., no warning is passed when doing > [!Note]

make a follow up for nitpicks

Should I make it case-insensitive so things like > [!Caution] work or should I make it require all caps so only > [!CAUTION] works?