Skip to content
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

Add readme command #313

Merged
merged 4 commits into from
Dec 14, 2015
Merged

Add readme command #313

merged 4 commits into from
Dec 14, 2015

Conversation

anandthakker
Copy link
Contributor

Closes #261

Chose to pull this into the codebase rather than referencing a separate documentation-readme package because:

  • Can share code with the build command
  • After externalizing mdast-util-inject, it's pretty slim.

cc @tmcw

@tmcw
Copy link
Member

tmcw commented Dec 14, 2015

Going to make one small tweak and then merge: if you specify a section that doesn't exist in a readme, this still passes the README content through mdast but doesn't add the API section. I think it should exit 1 in this case.

@anandthakker
Copy link
Contributor Author

Yep, good point.

@anandthakker
Copy link
Contributor Author

@tmcw ^ merged your PR to mdast-util-inject and updated here to error out if the specified section is absent.

@tmcw
Copy link
Member

tmcw commented Dec 14, 2015

👍 merging.

@tmcw tmcw merged commit bdd1f53 into master Dec 14, 2015
@tmcw tmcw deleted the readme-command branch December 14, 2015 15:21
rhendric pushed a commit to rhendric/documentation that referenced this pull request Sep 15, 2022
* Explain why Orphan Instances are forbidden

* review feedback

* Review feedback - Add explicit example

* Fix uniqueness typo

* Fix another uniques
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