Skip to content

Conversation

designatednerd
Copy link
Contributor

Hey, thanks so much for this project, it's super awesome. I'm using it to generate markdown-based documentation for apollo-ios since we've already got a theme that can generate HTML pages based on Markdown. The only issue is when that theme sees .md at the end of a link, it links directly to the markdown file rather than to the generated HTML page.

This PR adds the ability to customize the text at the end of a link in the README - in our case, switching to / instead of .md leads to the desired behavior, but in other cases someone might want .html instead. This change retains existing behavior of using .md as a link ending by default.

I also committed changes which were automatically applied to Package.lock when using swift run - let me know if you want me to revert that one, but it does not appear to have had any adverse affects.

Enhancements

  • Added ability to pass in a --link-ending parameter so that links in README.md index can be customized.

@designatednerd
Copy link
Contributor Author

Also threw in the ability to specify an input folder since it makes testing this against our final project way easier 😄

@designatednerd
Copy link
Contributor Author

....and an ability to prefix things since we need to go back up a directory. 😛

@eneko
Copy link
Collaborator

eneko commented Jul 22, 2019

Thank you for the PR, @designatednerd ! Really appreciate the update.

@eneko eneko merged commit e455c0e into SourceDocs:master Jul 22, 2019
@designatednerd
Copy link
Contributor Author

Awesome! @eneko Can you please ping me when the update is pushed to Homebrew so I can delete some workaround instructions from my docs?

@designatednerd
Copy link
Contributor Author

BTW our docs generated with this are now live if you wanna see 'em. 😃

@designatednerd designatednerd deleted the add/customizable-file-ending branch August 8, 2019 12:05
@eneko
Copy link
Collaborator

eneko commented Aug 14, 2019

@designatednerd Sorry for the delay, I'm prepping a 0.6.0 release, hope to have it on Homebrew soon. Meanwhile, please use master, let me know if that doesn't work for you.

Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants