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

Made Markdown formatting #29

Merged
merged 6 commits into from
Oct 29, 2022
Merged

Made Markdown formatting #29

merged 6 commits into from
Oct 29, 2022

Conversation

maxuver
Copy link
Contributor

@maxuver maxuver commented Oct 28, 2022

Made formatting of this article to Markdown format and add links & pictures & videos

Why it is important?

Related Issue

Made formatting of this article to Markdown format
@SwiftAdviser
Copy link
Member

The changes look good!

What I liked:

  • links to external services provided
  • more headers in the document
  • more formatting of the docs provided with necessary links
  • general improvements of the article provided

While some edits are necessary:

  1. Images should be hosted in /static/img/docs/ folder instead of GitHub
  2. All links to the ton.org/docs should be changed to the local articles on tonspace with local pathes (like /learn/web3/dns, etc)
  3. All links to telegra.ph like https://telegra.ph/TON-Payments-07-01 should be changed to the local articles on tonspace

@SwiftAdviser
Copy link
Member

Feel free to use this section for all related to web3:

image

@SwiftAdviser
Copy link
Member

And these articles instead of articles in telegra.ph:

image

1. Images should be hosted in /static/img/docs/ folder instead of GitHub
2. All links to the ton.org/docs should be changed to the local articles on tonspace with local pathes (like /learn/web3/dns, etc)
3. All links to telegra.ph like https://telegra.ph/TON-Payments-07-01 should be changed to the local articles on tonspace
@SwiftAdviser
Copy link
Member

Good! Pictures & videos are loaded in the repo. Links are changed to local articles 👍

Images

So, we have this right now:

image

But we need to change format for img in markdown:

  • ![description](/img/docs/sample_image.png)

Videos

Videos right now seem like this:

image

It will compile to usual links instead of video.

Here is an example from hacktoberfest page:

<div style={{textAlign:'center', margin: '0 auto'}}>
  <video width="300" style={{borderRadius:'10pt', margin:'15pt auto'}} muted={true} autoPlay={true} loop={true}>
    <source src="/img/docs/video.mp4" type="video/mp4" />
        Your browser does not support the video tag.
  </video>
</div>

Feel free to use this code & save time :)

@SwiftAdviser
Copy link
Member

Good!

@SwiftAdviser SwiftAdviser merged commit 08561b7 into ton-community:main Oct 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants