Repository: spark Updated Branches: refs/heads/branch-0.9 f2bf44adc -> 267d96c3d
Add Jekyll tag to isolate "production-only" doc components. (0.9 version) Author: Patrick Wendell <[email protected]> Closes #57 from pwendell/jekyll-prod-0.9 and squashes the following commits: 69a7614 [Patrick Wendell] Add Jekyll tag to isolate "production-only" doc components. Project: http://git-wip-us.apache.org/repos/asf/spark/repo Commit: http://git-wip-us.apache.org/repos/asf/spark/commit/267d96c3 Tree: http://git-wip-us.apache.org/repos/asf/spark/tree/267d96c3 Diff: http://git-wip-us.apache.org/repos/asf/spark/diff/267d96c3 Branch: refs/heads/branch-0.9 Commit: 267d96c3db0f4918b15c0c0264a1c846016fefcb Parents: f2bf44a Author: Patrick Wendell <[email protected]> Authored: Sun Mar 2 18:18:44 2014 -0800 Committer: Patrick Wendell <[email protected]> Committed: Sun Mar 2 18:18:44 2014 -0800 ---------------------------------------------------------------------- docs/README.md | 18 +++++++++++++++--- docs/_layouts/global.html | 4 ++-- docs/_plugins/production_tag.rb | 14 ++++++++++++++ 3 files changed, 31 insertions(+), 5 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/spark/blob/267d96c3/docs/README.md ---------------------------------------------------------------------- diff --git a/docs/README.md b/docs/README.md index 0b7c324..d35990c 100644 --- a/docs/README.md +++ b/docs/README.md @@ -10,9 +10,21 @@ We include the Spark documentation as part of the source (as opposed to using a In this directory you will find textfiles formatted using Markdown, with an ".md" suffix. You can read those text files directly if you want. Start with index.md. -To make things quite a bit prettier and make the links easier to follow, generate the html version of the documentation based on the src directory by running `jekyll` in the docs directory. Use the command `SKIP_SCALADOC=1 jekyll` to skip building and copying over the scaladoc which can be timely. To use the `jekyll` command, you will need to have Jekyll installed, the easiest way to do this is via a Ruby Gem, see the [jekyll installation instructions](https://github.com/mojombo/jekyll/wiki/install). This will create a directory called _site containing index.html as well as the rest of the compiled files. Read more about Jekyll at https://github.com/mojombo/jekyll/wiki. - -In addition to generating the site as html from the markdown files, jekyll can serve up the site via a webserver. To build and run a webserver use the command `jekyll --server` which (currently) runs the webserver on port 4000, then visit the site at http://localhost:4000. +The markdown code can be compiled to HTML using the +[Jekyll tool](http://jekyllrb.com). To use the `jekyll` command, you will +need to have Jekyll installed. The easiest way to do this is via a Ruby Gem, see the +[jekyll installation instructions](http://jekyllrb.com/docs/installation). +Compiling the site with Jekyll will create a directory called +_site containing index.html as well as the rest of the compiled files. + +You can modify the default Jekyll build as follows: + + # Skip generating API docs (which takes a while) + $ SKIP_SCALADOC=1 jekyll build + # Serve content locally on port 4000 + $ jekyll serve --watch + # Build the site with extra features used on the live page + $ PRODUCTION=1 jekyll build ## Pygments http://git-wip-us.apache.org/repos/asf/spark/blob/267d96c3/docs/_layouts/global.html ---------------------------------------------------------------------- diff --git a/docs/_layouts/global.html b/docs/_layouts/global.html index f2c101f..c487dd9 100755 --- a/docs/_layouts/global.html +++ b/docs/_layouts/global.html @@ -24,9 +24,9 @@ <link rel="stylesheet" href="css/pygments-default.css"> + {% production %} <!-- Google analytics script --> <script type="text/javascript"> - /* var _gaq = _gaq || []; _gaq.push(['_setAccount', 'UA-32518208-1']); _gaq.push(['_trackPageview']); @@ -36,8 +36,8 @@ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); })(); - */ </script> + {% endproduction %} </head> <body> http://git-wip-us.apache.org/repos/asf/spark/blob/267d96c3/docs/_plugins/production_tag.rb ---------------------------------------------------------------------- diff --git a/docs/_plugins/production_tag.rb b/docs/_plugins/production_tag.rb new file mode 100644 index 0000000..9f870cf --- /dev/null +++ b/docs/_plugins/production_tag.rb @@ -0,0 +1,14 @@ +module Jekyll + class ProductionTag < Liquid::Block + + def initialize(tag_name, markup, tokens) + super + end + + def render(context) + if ENV['PRODUCTION'] then super else "" end + end + end +end + +Liquid::Template.register_tag('production', Jekyll::ProductionTag)
