search

HubSpot / vex

A modern dialog library which is highly configurable and easy to style. #hubspot-open-source
http://github.hubspot.com/vex/docs/welcome
MIT License
6.92k stars 491 forks source link

Fix intro.md links and formatting #199

Closed janzenz closed 6 years ago

janzenz commented 7 years ago

The links weren't pointing to the correct page and the formatting for the Module Systems section was on HTML, changed it to Markdown.

bbatliner commented 7 years ago

Ah, so on Github, the links don't work correctly. But the docs are also published at http://github.hubspot.com/vex/, and the links are made to work there. Do you know how we could make these links work on both locations? The /vex/ prefix is necessary for the links to work on hubspot's hosted docs.

janzenz commented 7 years ago

@bbatliner Got it. Are you using Jekyll to generate the pages?

bbatliner commented 7 years ago

I'm not sure. @adamschwartz what does HubSpot use to generate the documentation on their website?

adamschwartz commented 7 years ago

https://www.npmjs.com/package/hsdoc

bbatliner commented 6 years ago

I like the idea of moving all the links to HubSpot's docs - we have script tags that don't work on GitHub and funneling people to the HubSpot docs will help everyone out.

The HTML renders fine on GitHub, for simple things.

I'm not sure the best way to give you credit for your work - I will merge in this PR to a separate branch, and then recommit the HTML, so you are a contributor, before moving it all back to master.