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

docs: syntax highlight from markdown #613

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/authorization.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ With `gcloud-node` it's incredibly easy to get authorized and start using Google

If you are running this client on Google Compute Engine, we handle authorization for you with no configuration. You just need to make sure that when you [set up the GCE instance][gce-how-to], you add the correct scopes for the APIs you want to access.

``` js
```js hljs-class
var config = {
projectId: 'grape-spaceship-123'
};
Expand All @@ -26,7 +26,7 @@ If you are not running this client on Google Compute Engine, you need a Google D
* If you want to use a new service account, click on **Create new Client ID** and select **Service account**. After the account is created, you will be prompted to download the JSON key file that the library uses to authorize your requests.
* If you want to generate a new key for an existing service account, click on **Generate new JSON key** and download the JSON key file.

``` js
``` js hljs-class
var config = {
projectId: 'grape-spaceship-123',
keyFilename: '/path/to/keyfile.json'
Expand Down
2 changes: 1 addition & 1 deletion docs/site/components/authorization/authorization.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,5 @@
<div subpage
header-templateUrl="authorization-header.html"
title="Authorization">
<btf-markdown ng-include="'authorization.md'"></btf-markdown>
<btf-markdown highlight-markdown ng-include="'authorization.md'"></btf-markdown>
</div>
61 changes: 60 additions & 1 deletion docs/site/components/subpage/subpage-directive.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
angular
.module('gcloud.subpage', ['gcloud.header'])
.module('gcloud.subpage', ['gcloud.header', 'hljs'])

.directive('subpage', function($rootScope, $location, $http, $parse, getLinks, versions) {
'use strict';

Expand Down Expand Up @@ -34,4 +35,62 @@ angular
}
}
};
})

// A special class used in our MD files to tell the front end to syntax
// highlight the code blocks.
.directive('hljsClass', function() {
'use strict';

return {
// Concept borrowed from:
// http://www.bennadel.com/blog/2748-compiling-transcluded-content-in-angularjs-directives.htm
//
// <div class="hljs-class">
// var hi = 'there'; <!-- We want this!
// </div>
//
// We want to replace that with:
//
// <div hljs language="javascript" source="var hi = 'there';"></div>
//
// To get the content we want, we have to use a higher priority than
// another same-named directive that uses transclude. This is our only
// chance to get it before it's clobbered.
priority: 1500.1,
restrict: 'C',
compile: function(element, attrs) {
attrs._contents = element.text();
}
};
})

.directive('hljsClass', function() {

This comment was marked as spam.

This comment was marked as spam.

'use strict';

return {
priority: 1500,
restrict: 'C',
transclude: true,
template: '<div hljs language="javascript" source="contents"></div>',
compile: function(element) {
return function($scope, element, attrs) {
$scope.contents = attrs._contents;
};
}
}
})

// Re-compile the Markdown, this time having the "hljs-class" blocks picked
// up.
.directive('highlightMarkdown', function($compile) {
'use strict';

return {
link: function(scope, element, attrs) {
scope.$watch(attrs.ngInclude, function() {
$compile(element.contents())(scope);
}, true);
}
};
});
5 changes: 5 additions & 0 deletions docs/site/css/main.css
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,11 @@ pre {
line-height: 1.6em;
}

[hljs] > pre {
margin: 0 !important;
font-size: 1em;
}

pre,
code {
font-family: Monaco, 'Droid Sans Mono', monospace !important;
Expand Down