Closed be-engineer closed 1 year ago
Hi, does this happen when you build your docs locally? And please provide all correct URLs that we ask on the template, so it's easier to help you.
The document I created on github was compiled on rtd and written in vscode. The warning icon can be displayed when previewed on vscode, but it becomes text after being compiled on rtd. The address of the document is https://mikrotik-doc-cn.readthedocs.io/zh/latest/Getting_started/Software_Specifications/index.html
Others like !!!info, !!!note are also displayed as text instead of icons
@be-engineer Read the Docs is building your documentation using sphinx, that may be different on how GitHub renders the documents (GitHub uses its own flavor of markdown). You may want to check our tutorial if you are not familiar with Sphinx https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html, there we have steps to use rst or markdown.
Excuse me, how can I modify it?
Details
I use markdown syntax in my documentation,like this
Expected Result
The effect should be like this. This is also the effect in markdown preview
A description of what you wanted to happen
Actual Result
But the effect obtained after compiling from rtd is as follows,what should I do?
A description of what actually happened