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

Add Examples to the Documentation #32

Closed
6 tasks done
lelouchB opened this issue Oct 6, 2020 · 17 comments · Fixed by #39
Closed
6 tasks done

Add Examples to the Documentation #32

lelouchB opened this issue Oct 6, 2020 · 17 comments · Fixed by #39
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed up-for-grabs

Comments

@lelouchB
Copy link
Owner

lelouchB commented Oct 6, 2020

There is only one example present right now in the documentation i.e. Live React Example which can be found here
https://finalspaceapi.com/docs/react/

Docusarus uses React Live for the interactive coder so it will only support React.

Add more example with the language and frameworks of your choice.

Resource:
https://v2.docusaurus.io/docs/markdown-features/#syntax-highlighting

https://v2.docusaurus.io/docs/markdown-features/#interactive-code-editor

P.S. it doesn't necessarily have to be a live example. You can add simple code snippets with their output too.

Here are a few ideas for this

Completed

Rest is up to your imagination.

@lelouchB lelouchB added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers hacktoberfest up-for-grabs labels Oct 6, 2020
@lelouchB lelouchB mentioned this issue Oct 6, 2020
@fernandoamz
Copy link
Contributor

@lelouchB, May I add an example with react + axios ?

@fernandoamz
Copy link
Contributor

fernandoamz commented Oct 6, 2020

@lelouchB, May I add an example with Vainilla too? and with Ajax?

@lelouchB
Copy link
Owner Author

lelouchB commented Oct 6, 2020

Hey @fernandoamz
Lets do one at a time, I am assigning you for React + Axios

After you are done with, if other are available
I will assign it you
Thanks

Looking forward to your contributions.

@lelouchB lelouchB pinned this issue Oct 6, 2020
@fernandoamz
Copy link
Contributor

fernandoamz commented Oct 6, 2020

👋 Hey @lelouchB, I am new on docusaurus, May you share me an example as to how to add an import into the theme-live-codeblock? I searched information but I couldn't resolve it. Thanks.

I have an error on the Result because I am not importing Axios
Screen Shot 2020-10-06 at 3 56 57 PM

@lelouchB
Copy link
Owner Author

lelouchB commented Oct 7, 2020

Hey , @fernandoamz
Sorry for the late response
I see that you have figured this issue out. Great 👍

@bobluppes
Copy link
Contributor

Hey @lelouchB, could I make an example in Vue.js? Would very much like to try out your API at the same time ;)

@lelouchB
Copy link
Owner Author

lelouchB commented Oct 8, 2020

@bobluppes
Ofcourse
I will assign this issue to you as well.

@lelouchB
Copy link
Owner Author

lelouchB commented Oct 8, 2020

@bobluppes
If you could use the episode endpoint in the example.

https://finalspaceapi.com/docs/episode

@bobluppes
Copy link
Contributor

Oh cool, is the endpoint finished now. Will definitely use it then. Expect a PR this evening or tomorrow morning

@PSmigielski
Copy link
Contributor

Could i make vanilla JS and axios examples ?

@lelouchB
Copy link
Owner Author

lelouchB commented Oct 9, 2020

Could i make vanilla JS and axios examples ?

Sure @PSmigielski

@Devdre1909
Copy link
Contributor

Hi @lelouchB, can I make Vue and Axios Examples?

@lelouchB
Copy link
Owner Author

@Devdre1909
yeah Sure,
As you already know this will be static example.
Be as creative as you can.

Use location endpoint and add screenshot of the Output too.

@guzbarraf
Copy link
Contributor

Hi @lelouchB, give me the example in angular

@lelouchB
Copy link
Owner Author

Awesome
Thanks @guzbarraf

@fullstackmafia
Copy link

Hi @lelouchB - I took a look at this and I think it's awesome. Could I make an example with SvelteJS and Axios?

@lelouchB
Copy link
Owner Author

Hi @lelouchB - I took a look at this and I think it's awesome. Could I make an example with SvelteJS and Axios?

@fullstackmafia Sure, Go for It!
Let me know if you have any questions.

@bobluppes bobluppes removed their assignment Aug 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed up-for-grabs
Projects
None yet
Development

Successfully merging a pull request may close this issue.

7 participants