Better Docs

[TheComputerM]

I am spending much of my time and energy on completing the components and making them robust, I am completing the documentation in a hurry, some problems with the current docs are:

• a little bland
• not much information
• may be a few typos present
• ~~no interactive way to change the component props (a repl like thing).~~

If you encounter any problems and want to fix them, open an issue or PR. Any suggestions are also welcome.

[csaltos]

Thank you Mudit for svelte-materialify, it's very impressive.

Regarding the documentation, I think it would be very useful if you help it provide a starter working repo with a Hello World using a couple of components.

Also valuable is if you provide the source code of the components demoed at the docs.

Once again thank you very much for your cool code !!

[TheComputerM]

Glad you like svelte-materialify. Will create a starter repo once this hits a major release. And can you clarify what you mean by viewing the source code, there is a button on the top right of each example to see the source code.

[csaltos]

That's funny !!! ... this is an a11y error -> the icons for those buttons failed to load and with that, they become inexistent in the browser (because the background of those buttons is the same gray as the bar they are layout on).

Most of the time people oversight a11y but it's important ... and actually fixing it is easy -> like here changing the background of the buttons to a higher contrast combination and especially adding an "alt" text to icons images to express the functionality even on a slow network connection or any other general download error of the icons images.

Looking forward to the major release. In the meantime, I'm learning a lot reading your cool code. I will try to help on the tests and maybe a couple of PR if I feel brave enough to commit my "shy" code to your cool repo.

[TheComputerM]

What browser are you on? firefox has a bug with cache.

[csaltos]

Yes, Firefox indeed ... I check on Safari and it's OK.

[TheComputerM]

Here is a sapper template with svelte-materialify if you need one: https://github.com/TheComputerM/sapper-materialify-template

[csaltos]

GREAT !! ... thank you very much mate, really appreciated !! 👍😎

[homimickey]

heyy ...@TheComputerM Really amazed by your work i don't understand why is it not getting popular...... I am a newbie in svelte ...

encountered an issue with docs

when i click code <> button i get undefined but all github links are working fine..

really amazing work @TheComputerM Thank you.....

[TheComputerM]

@homimickey Glad you liked it, fixed the issue (it was related to path formatting on linux). If someone asks you for a good material design framework for svelte, tell this about this project 😄.

If you find a bug in the future, open a new issue, this thread is to track improvements and suggestions for the docs.

[homimickey]

I will definitely recommend svelte-materialify thanks man... for fixing it...

Feature Request !!!

a copy code button so that it would be helpful and easy... to steal your code 😄😄

[TheComputerM]

@homimickey Added a copy code button.

[homimickey]

Thank you very much .... !!! @TheComputerM

[Ajitweb]

Thank you @TheComputerM for the fantastic effort.

A small typo in https://svelte-materialify.vercel.app/styles/spacing/

Where property can be: m: applies margin m: applies padding

It should be p: applies padding