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 support to use mdoc #293

Merged
merged 6 commits into from
Jan 10, 2019
Merged

Add support to use mdoc #293

merged 6 commits into from
Jan 10, 2019

Conversation

rafaparadela
Copy link
Contributor

This PR closes #292

What it does basically is:

  • Adds a new sbt setting micrositeCompilingDocsTool to chose between tut and mdoc.
  • Edits the task makeMicrosite to run either makeTut or makeMdoc according to the value of micrositeCompilingDocsTool.
  • Adds the sbt-mdoc pluging.
  • Adds a scripted test to prove the compilation of mdoc snippets
  • Adds a scripted test to prove how makeMicrosite ends without effects when the micrositeCompilingDocsTool has an invalid value.
  • Updates the documentation to explain how operate with both options and a detailed guide for migrating from tut to mdoc.

@rafaparadela
Copy link
Contributor Author

rafaparadela commented Jan 5, 2019

@juanpedromoreno It seems that Travis gives us a red in the 0.13 & 2.10 version as we discussed yesterday.

@juanpedromoreno
Copy link
Member

@rafaparadela I'll try to have a look at this today. Thanks.

Copy link
Contributor

@calvellido calvellido left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great Rafa 👏👏

Copy link
Member

@juanpedromoreno juanpedromoreno left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The code looks good to me @rafaparadela , thank you!!

@MaureenElsberry
Copy link
Contributor

@rafaparadela done reviewing the docs, only made tiny changes. Thanks!

@rafaparadela
Copy link
Contributor Author

Thanks a lot @MaureenElsberry

@rafaparadela rafaparadela merged commit 8628e97 into master Jan 10, 2019
@rafaparadela rafaparadela deleted the add-mdoc-capabilities branch January 10, 2019 00:34
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.

Change tut for mdoc
4 participants