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

Added code syntax highlighting for tutorials #1850

Merged
merged 2 commits into from May 30, 2018

Conversation

Projects
2 participants
@suxino
Copy link

suxino commented May 30, 2018

Introduction

Added Code syntax highlighting to for tutorials

Motivation

Make it easier to read

@ricardograca ricardograca added the docs label May 30, 2018

@ricardograca
Copy link
Member

ricardograca left a comment

Thanks for this, but there's a small problem. These tutorials aren't meant to be read separately, although that works. They are meant to be included in the website and that is generated using JSDoc, that's why you see the {@link Model#belongsToMany belongsToMany} stuff when you see the files on their own.

That said, it is acceptable to use GitHub flavoured markdown for syntax highlighting, but then you also have to remove the 4 spaces indentation of those blocks, otherwise the alignment is off.

@ricardograca
Copy link
Member

ricardograca left a comment

Much better. Thanks!

@ricardograca ricardograca added this to To Do in Version 0.14.0 via automation May 30, 2018

@ricardograca ricardograca merged commit 70e921b into bookshelf:master May 30, 2018

1 check passed

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

Version 0.14.0 automation moved this from To Do to Done May 30, 2018

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