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

Conversation

Projects
None yet
4 participants
@rafaparadela
Copy link
Member

rafaparadela commented Jan 5, 2019

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

This comment has been minimized.

Copy link
Member 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

This comment has been minimized.

Copy link
Contributor

juanpedromoreno commented Jan 8, 2019

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

@calvellido
Copy link
Contributor

calvellido left a comment

This is great Rafa 👏👏

@juanpedromoreno
Copy link
Contributor

juanpedromoreno left a comment

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

MaureenElsberry added some commits Jan 9, 2019

@MaureenElsberry

This comment has been minimized.

Copy link
Collaborator

MaureenElsberry commented Jan 9, 2019

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

@rafaparadela

This comment has been minimized.

Copy link
Member Author

rafaparadela commented Jan 10, 2019

Thanks a lot @MaureenElsberry

@rafaparadela rafaparadela merged commit 8628e97 into master Jan 10, 2019

2 checks passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
continuous-integration/travis-ci/push The Travis CI build passed
Details

@rafaparadela rafaparadela deleted the add-mdoc-capabilities branch Jan 10, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment