-
-
Notifications
You must be signed in to change notification settings - Fork 3.1k
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
Fix link to extending.md #471
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
EDIT: Actually, just wondering. Should it be the full link (https://github.com/netlify/netlify-cms/blob/master/docs/extending.md), the way we currently have it in intro.md? Not sure if it makes a difference.
A root relative path is better, actually, same way I did it in my latest PR. Not sure if we have a consistent approach across the docs. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ryanclarke thanks for this! I'm now wondering if there are other links where this is happening.
The problem here is that the repo docs are used to generate the docs site. The repo needs .md
, but the docs site needs the extension left off. We'll need to determine the right approach. We're using Markdown Magic in the docs repo, maybe it's just a configuration thing.
Another option is to simply remove the extension from the files themselves, but we'll consider that a last resort.
So here's what I'm seeing:
We may also consider other means for transforming source repo docs to html, but a quick search did not reveal anything promising. |
We can likely look to the docs implementation used by Serverless, primarily coded by @DavidWells, who also created Markdown Magic. They keep docs in the repo, as in this page (note the link at the bottom points to an .md file) Then use those files to generate the main site, as in this page (with no extension on the last link) I don't think they use Markdown Magic as a separate entity, but have it integrated into the code (before MM was broken out). Code for content importing and conversion can be found in here: |
@verythorough good find - the conversion happens here: https://github.com/serverless/site/blob/master/scripts/docs/update-doc-content.js#L55 |
This will be properly fixed under #511. Closing. |
The ".md" filetype was missing from the link path.