docs: added uniform id from apisix doc #4474
Conversation
| @@ -21,7 +21,7 @@ title: Getting Started | |||
| # | |||
| --> | |||
|
|
|||
| ## Getting Started | |||
| ## Getting Started {#apisix} | |||
There was a problem hiding this comment.
This breaks the render in the GitHub markdown preview (maybe also the cross reference). Can we add the mark into <!-- --> and take it away from the title?
There was a problem hiding this comment.
No we can't do that, and i have tested this on my system it works fine
There was a problem hiding this comment.
its not the title , the title is above the license text
There was a problem hiding this comment.
@iamayushdas I suggest submitting PRs on one repo for test & preview, let's have a preview here apache/apisix-dashboard#1951 first.
There was a problem hiding this comment.
It is the title from the view of the markdown version. See https://github.com/apache/apisix/blob/master/docs/en/latest/getting-started.md
There was a problem hiding this comment.
I can't accept such a scar on the title. The solution is quite a hack. How can a mark be put into the content, especially the content is obvious to everyone?
There was a problem hiding this comment.
@spacewander Sir, first of all I am extremely sorry flooding PRs without discussing,
My PROPOSAL:
Docusaurus has opted this way for adding id's to be more precise. they have changed the md style in such a way that we can add precise id without harming our website
reference md file - https://github.com/facebook/docusaurus/blob/master/website/docs/api/plugins/plugin-content-blog.md
screenshot:
website created from above md file: https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog
screenshot:
https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog
now please visit this issue: apache/apisix-website#363
What this PR does / why we need it:
uniform/particular id given to the documentation
issue: apache/apisix-website#363
Pre-submission checklist: