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

fix(docs): should fix #399 and unify the markdown syntax #413

Merged
merged 1 commit into from Aug 25, 2021

Conversation

EmileRolley
Copy link
Collaborator

@EmileRolley EmileRolley commented Aug 20, 2021

Related issue: #399

Major changes are:

  • Indent code blocks inside lists.

    Sould fix Documentation bug: markdown syntax errors #399 , but to be sure we have to wait until the GitHub page is updated.

  • Unify the markdown syntax for the tutorial steps (e.g. new line after headings and - for all list items).

Copy link
Member

@erikmd erikmd left a comment

Choose a reason for hiding this comment

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

Thanks @EmileRolley, the diff looks very fine.

So, I'm merging it; and as you suggest, let's double-check the outcome afterwards.

@erikmd erikmd merged commit f7bf420 into ocaml-sf:master Aug 25, 2021
@erikmd
Copy link
Member

erikmd commented Aug 25, 2021

Yes, it looks very OK now: for example, I saw no more dangling ``` here and there.

So thanks @EmileRolley for your PR and for the small typos you corrected along the way!

@EmileRolley
Copy link
Collaborator Author

You are welcome, glad to see that it worked!

@EmileRolley EmileRolley deleted the fix-md-syntax-err branch August 26, 2021 08:39
@erikmd erikmd self-assigned this Sep 29, 2021
@erikmd erikmd added this to the learn-ocaml 0.13.0 milestone Nov 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation bug: markdown syntax errors
2 participants