Docusaurus: [Docs] Document how static assets (such as images) should be handled

[hramos]

See https://github.com/facebookexperimental/Docusaurus/blob/master/lib/server/generate.js#L183

It looks like we automatically handle converting 'assets/' references to 'docs/assets'.

Does that mean I should create an 'assets' folder in my docs folder for all my images? Will Docusaurus copy images from that assets folder to the right place?

[hramos]

Yep, it looks like we handle this automatically <3

Images placed into docs/assets are copied to the right place. References to assets/myImage.png will correctly load the image when the site is rendered.

Let's document it?

[zhaozhiming]

Yes. The example as bellow should be change to ![alt-text](assets/doc-image.png).
And it seems have been changed already. See here.

[longility]

I believe this issue can be closed.

[JoelMarcey]

@longility Did we document this? Sometimes I forget 😄

[longility]

@JoelMarcey I by no means have tested what this documentation says. I'm just helping close some issues so I may not be too familiar with this.

After a little more investigation, the generated doc from gh-pages does not reflect the markdown source. Not sure why as I would expect it to have already been deployed as it has been more than seven months.

[endiliey]

@longility: Changes to docs/ are reflected in the next "master" version.

I am closing this issue. It is documented at
https://docusaurus.io/docs/en/doc-markdown.html#linking-to-images-and-other-assets