Skip to content

Commit 129f2a6

Browse files
committed
Add jekyll binstub
Make readme instructions more explicit Exclude some files from build in sample configuration
1 parent ef33d1c commit 129f2a6

File tree

3 files changed

+33
-6
lines changed

3 files changed

+33
-6
lines changed

README.md

+16-6
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,28 @@
1-
Magento Developer Documentation
2-
=================================
1+
# Magento Developer Documentation
32

43
Welcome! This site contains the latest Magento developer documentation for ongoing Magento 2.0 releases.
54

65
To contribute, please fork the develop branch. We won't accept pull requests into master.
76

8-
**NEW!** You can now build this site yourself using Jekyll. Just rename `_config.devdocs.yml` to `_config.yml` and you're set. If you have questions, open an issue and ask us.
7+
# Building this site
98

10-
We're looking forward to hearing from you!
9+
You can build this site yourself using Jekyll. Here's how:
10+
11+
```bash
12+
# Copy the sample config file and name it "config.yml"
13+
$ cp _config.devdocs.yml _config.yml
14+
15+
# Install dependencies
16+
$ bundle install
17+
18+
# Visit http://localhost:4000 in your favorite browser!
19+
$ bin/jekyll serve
20+
```
21+
22+
If you have questions, open an issue and ask us. We're looking forward to hearing from you!
1123

1224
* <a href="https://twitter.com/MagentoDevDocs" class="twitter-follow-button" data-show-count="false">Follow @MagentoDevDocs</a>
13-
<script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script>
1425

1526
* <a href="mailto:[email protected]">E-mail us</a>
1627

1728
* <a href="http://devdocs.magento.com">Visit our documentation site</a>, built on GitHub using [Jekyll](http://jekyllrb.com/).
18-

_config.devdocs.yml

+1
Original file line numberDiff line numberDiff line change
@@ -30,3 +30,4 @@ gems:
3030
# Build settings
3131
markdown: kramdown
3232
highlighter: pygments
33+
exclude: [bin, _config.yml, Gemfile, Gemfile.lock, README.md]

bin/jekyll

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
#!/usr/bin/env ruby
2+
#
3+
# This file was generated by Bundler.
4+
#
5+
# The application 'jekyll' is installed as part of a gem, and
6+
# this file is here to facilitate running it.
7+
#
8+
9+
require 'pathname'
10+
ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
11+
Pathname.new(__FILE__).realpath)
12+
13+
require 'rubygems'
14+
require 'bundler/setup'
15+
16+
load Gem.bin_path('jekyll', 'jekyll')

0 commit comments

Comments
 (0)