-
Notifications
You must be signed in to change notification settings - Fork 74
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
Readme tweaks #54
Readme tweaks #54
Conversation
Does this need a |
Not necessarily if we maintain the toc by hand.
Tell me then if I should remove it or no.
|
I have no opinion. I hate the API.md idea. So, whatever makes it work properly is fine with me. |
Toc generation is independent from the API.md decision, though it has helped me a lot consistently getting the toc right and avoiding useless PRs. Your choice. |
I added then the toc generation from joi. |
@@ -16,11 +16,14 @@ | |||
"hoek": "3.x.x" | |||
}, | |||
"devDependencies": { | |||
"lab": "7.x.x" | |||
"lab": "8.x.x", | |||
"markdown-toc": "^0.12.3" |
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.
Can't guarantee it'll keep working with a 0.x version, this should be made sticky to 0.12 as joi did.
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.
you mean keep lab 7?
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.
No, markdown-toc. Semver doesn't really apply the same way prior to v1.x.x. Can you drop the ^
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.
okey dokey.
Didn't know about that.
Shall I made a dedicated PR?
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.
Yes please.
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.
voilà: #55
This thread has been automatically locked due to inactivity. Please open a new issue for related bugs or questions following the new issue template instructions. |
Extract Api.md so it would be more easy to include it with hapijs.com plugin pages.