feat: support reference-style linking in documents #1048
Conversation
|
Thank you for your pull request and welcome to our community. We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file. In order for us to review and merge your code, please sign up at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need the corporate CLA signed. If you have received this in error or have any questions, please contact us at cla@fb.com. Thanks! |
phated
force-pushed
the
reference-links
branch
from
87abf1f
to
c26e0dd
Compare
|
Deploy preview for docusaurus-preview ready! Built with commit 87abf1f |
|
Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Facebook open source project. Thanks! |
phated
force-pushed
the
reference-links
branch
from
c26e0dd
to
3976dd5
Compare
|
Deploy preview for docusaurus-preview ready! Built with commit c26e0dd |
|
Deploy preview for docusaurus-preview ready! Built with commit 62968ae |
|
@endiliey before I add the tests, is this a passable solution? |
|
Seems so to me. Though i wanted to confirm it through tests and see what are you trying to achieve. Im not quite sure on the reference style linking |
|
@phated Do you have the Gulp Docusaurus website hosted somewhere for us to have a look? |
|
It's not available yet. We're putting some finishing touches on next week. |
|
@phated I'm interested in seeing the WIP too if possible. On a side note, I see that the unofficial Gulp docs - https://gulpjs.org/ is built using VuePress so I'm surprised that you're still going ahead with a Docusaurus version (you're welcome to of course). |
yangshun
changed the title
|
Like you said, it's the unofficial docs and has nothing to do with us. Our domain is gulpjs.com for the official project. |
|
@yangshun if you didn't catch the gulp announcement yesterday - our docusaurus website is live at https://gulpjs.com/docs/en/getting-started/quick-start |
|
@phated I didn't catch it. This is sweet! Would you mind submitting a PR to add Gulp has a pinned user to Docusaurus website? Congrats on the launch! |
phated
force-pushed
the
reference-links
branch
from
d7370ca
to
5f97dd5
Compare
phated
force-pushed
the
reference-links
branch
from
5f97dd5
to
4de9b6d
Compare
There was a problem hiding this comment.
LGTM
So there are two ways of referencing link
// inline-style links :
This is [Document 1](doc1.md)
// reference-style links e.g:
This is [Document 1][doc1].
Then anywhere in the document
[doc1]: doc1.mdI did a small test
Works great
I added the v2 implementation as well in this PR
endiliey
changed the title
|
Could we get a 1.x release for this? I need our team members to have an installable version to publish with. |
|
@phated Sorry for the delay, we just released v1.5.1 on npm. |
Motivation
Needed reference link support for the gulp docusaurus website. Fixes #257
Have you read the Contributing Guidelines on pull requests?
Yep.
Test Plan
Create a page with a reference link that is described in #257 and generate a Docusaurus page. The link should be replaced correctly.
I wanted to submit this as a proposal for a fix because I'm using local changes currently. If you need changes or tests added, just let me know. Thanks!
Related PRs
(If this PR adds or changes functionality, please take some time to update the docs at https://github.com/facebook/docusaurus, and link to your PR here.)