brohlson / gatsby-plugin-anchor-links

⚓ Gatsby plugin for using smooth scroll anchor links with a Gatsby Link component
https://www.npmjs.com/package/gatsby-plugin-anchor-links
MIT License
68 stars 22 forks source link

Clarify errorTypes.IMPROPPER_FORMATTING message #24

Closed Undistraction closed 4 years ago

Undistraction commented 4 years ago

Given that anchor tags without paths are perfectly valid, it would be helpful to explain why they 'should contain an absolute root path'. It isn't mentioned anywhere in the README.

brohlson commented 4 years ago

They are not valid - it is mentioned in the readme.

You can provide anchor or non-anchor links to this component for ease of use. If you use it as an anchor component, be sure to include both a base path and hash in the to string.