From 3e7a58cef0d263db871ff994bd014a9394890692 Mon Sep 17 00:00:00 2001 From: John Ericksen Date: Wed, 18 Feb 2015 20:29:44 -0700 Subject: [PATCH 1/5] Changed pygments to highlighter --- _config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_config.yml b/_config.yml index 47355cf9807bf..340d8f6e32e6e 100644 --- a/_config.yml +++ b/_config.yml @@ -1,7 +1,7 @@ # jekyll configuration title: "Jekyll-asciidoc-quickstart" -pygments: true +highlighter: true asciidoctor: attributes: From 7c97ba32a546af9216669f1ea0822f4d5659bf08 Mon Sep 17 00:00:00 2001 From: John Ericksen Date: Wed, 18 Feb 2015 21:03:59 -0700 Subject: [PATCH 2/5] Streamlining L&F and content --- README.adoc | 90 ++++++++++++++++++++++--------------------- _layouts/default.html | 16 -------- index.adoc | 9 +++-- 3 files changed, 52 insertions(+), 63 deletions(-) diff --git a/README.adoc b/README.adoc index a7d2204b5263b..6b14a16ee0d80 100644 --- a/README.adoc +++ b/README.adoc @@ -1,42 +1,11 @@ = Jekyll AsciiDoc Quickstart :toc: -== Congratulations! +The Jekyll AsciiDoc Quickstart project is a leg-up in starting your own website hosted on Github with content based in AsciiDoc. This project combines the power of AsciiDoc with a beautiful CSS framework ontop of Github's existing publishing infrastructure. -You've taken the first step down an easy path of blogging with Jekyll. Not only that, you've chosen AsciiDoc over Markdown which will give you fine control of the structure of your posts, and will make them display beautifully when you publish them using the default mobile-first stylesheets included in this repository. += Directions -== GitHub Pages and AsciiDoc - -GitHub Pages does not (yet) whitelist the jekyll-asciidoc plug-in, so you can not write `.adoc` posts and have them instantly publish like Markdown posts do. - -Unlike some "fork and write" repositories that exist for Markdown blogs, you need to initially configure this repository fork with a computer to publish using AsciiDoc. - -=== How We Work Around The Limitation - -For this repository, the https://travis-ci.org/[Travis CI] Continuous Integration (CI) server emulates GitHub Pages staging automation, and pushes your blog live upon committing any change to the repository. - -After initially configuring the repository, you can use Git command-line on your computer, or even a Git client on your tablet or smartphone to write, commit, and automatically publish blog posts. - -=== Help Get AsciiDoc Whitelisted for GitHub Pages - -You can help change the lack of native AsciiDoc support by creating a support case through http://github.com/support. - -Tell the GitHub team that you want the choice to write in AsciiDoc, and have it handled the same way Markdown is when pushed to your GitHub Page. - -Your voice counts: make it heard! - -== Repository Structure - -The repository requires the following structure to work correctly: - -* **master**, for markup sources and configuration. This branch can be named anything you choose, however **master** is a general standard used in Jekyll blogs. -* **gh-pages**, for the generated static content produced by Travis CI. This branch is the username.github.io GitHub Pages domain, which is created automatically for you when the Travis CI job runs. - -== Configuring the Repository for Publishing - -The goal of this procedure set is to configure a Travis CI job to listen for commits on the _master_ branch, automatically run the Jekyll build, and push the generated content to the _gh-pages_ branch. - -=== Install Minimum Jekyll Requirements +=== 1. Install Minimum Jekyll Requirements You must install some software to execute commands in subsequent procedures. Meet the Requirements on the http://jekyllrb.com/docs/installation/[Jekyll Installation] page, which links to pages describing how to install: @@ -47,7 +16,7 @@ For yum-based package managers, the command to run is: $ sudo yum install ruby rubygems -=== Install Travis Gem +=== 2. Install Travis Gem When you install rubygems, you can use the gem internal package management system to install the Travis CI gem. This gem contains--among other things--a command-line tool for easily encrypting GitHub tokens. @@ -55,7 +24,7 @@ Run the following command to install the Travis gem: $ gem install travis -=== Enable Travis CI +=== 3. Enable Travis CI Travis CI is configured initially through a browser. @@ -63,10 +32,10 @@ To activate Travis CI for the Repository: . Open https://travis-ci.org and create an account. . Open your https://travis-ci.org/profile/[profile page] on Travis. -. Find the Jekyll repositorysitory, and turn on the switch. -. Click on repositorysitory settings (next to the switch) and enable “Build only if .travis.yml is present.” +. Find the Jekyll repository, and turn on the switch. +. Click on repository settings (next to the switch) and enable “Build only if .travis.yml is present.” -=== Generate a GitHub Personal Access Token +=== 4. Generate a GitHub Personal Access Token Once the repository is activated in Travis, you need a GitHub token to pass into the Travis keytool. @@ -76,7 +45,7 @@ To generate a new personal access token on GitHub: . Select the scope _public_repository_, and add a terse description. . Confirm and save the settings. -=== Encrypt the GitHub Token for Travis CI +=== 5. Encrypt the GitHub Token for Travis CI With the GitHub token created, you can now pass it to the Travis command-line tool, which adds the encryped value to a file in your repository. @@ -98,14 +67,47 @@ env: + . Commit all changes, and push to GitHub. -=== Verify the Configuration +=== 6. Verify the Configuration -To verify if you have configured the repository correctly, open https://travis-ci.org and verify that Travis starts, and subsequenty finishes processing the job. +To verify if you have configured the repository correctly, open https://travis-ci.org and verify that Travis starts, and subsequently finishes processing the job. -Travis places the built site into the _gh-pages_ branch upon completion. +Travis should place the built site into the _gh-pages_ branch upon completion. -== Summary +== 7. Summary If you can load the `[username].github.io/index.html/` home page, you have successfully completed basic configuration. Start writing blog posts and enjoy the AsciiDoc difference, regardless of what device you choose: computer, tablet, or mobile. + += Details + +== GitHub Pages and AsciiDoc + +GitHub Pages does not (yet) whitelist the jekyll-asciidoc plug-in, so you can not write `.adoc` posts and have them instantly publish like Markdown posts do. + +Unlike some "fork and write" repositories that exist for Markdown blogs, you need to initially configure this repository fork with a computer to publish using AsciiDoc. + +=== How We Work Around The Limitation + +For this repository, the https://travis-ci.org/[Travis CI] Continuous Integration (CI) server emulates GitHub Pages staging automation, and pushes your blog live upon committing any change to the repository. + +After initially configuring the repository, you can use Git command-line on your computer, or even a Git client on your tablet or smartphone to write, commit, and automatically publish blog posts. + +=== Help Get AsciiDoc Whitelisted for GitHub Pages + +You can help change the lack of native AsciiDoc support by creating a support case through http://github.com/support. + +Tell the GitHub team that you want the choice to write in AsciiDoc, and have it handled the same way Markdown is when pushed to your GitHub Page. + +Your voice counts: make it heard! + +== Repository Structure + +The repository requires the following structure to work correctly: + +* **master**, for markup sources and configuration. This branch can be named anything you choose, however **master** is a general standard used in Jekyll blogs. +* **gh-pages**, for the generated static content produced by Travis CI. This branch is the username.github.io GitHub Pages domain, which is created automatically for you when the Travis CI job runs. + +== Configuring the Repository for Publishing + +The goal of this procedure set is to configure a Travis CI job to listen for commits on the _master_ branch, automatically run the Jekyll build, and push the generated content to the _gh-pages_ branch. \ No newline at end of file diff --git a/_layouts/default.html b/_layouts/default.html index 41f7b781b0a55..192ce968a8a7f 100644 --- a/_layouts/default.html +++ b/_layouts/default.html @@ -36,22 +36,6 @@

  • Menu
    • - -
    - - -
    diff --git a/index.adoc b/index.adoc index 344bb2f1967f6..5ae21455e54f1 100644 --- a/index.adoc +++ b/index.adoc @@ -14,9 +14,6 @@ You've successfully set up and deployed an Jekyll website powered by Asciidoc us Now that you've set up your website to run with Asciidoc you have a ton of options available to you. -==== Update Look and feel -The layout provided with the https://github.com/asciidoctor/jekyll-asciidoc-quickstart[Jekyll-Asciidoc Quickstart] project is based on http://foundation.zurb.com[Foundation], a responsive design css framework. You're free to update the layout by editing the `_layouts/default.html` file and css under the `css` directory. - ==== Edit content Editing content is very simple. The easiest way to update your blog is to clone your repository, fire up your favorite text editor and run the content locally. To do this run the `jekyll serve` command and open a web browser to http://localhost:4000. Jekyll will automatically process and host changes to the content. @@ -35,6 +32,12 @@ To display a list of posts, use Jekyll syntax similar to the following: {% endraw %} -- + +==== Update Look and feel +The layout provided with the https://github.com/asciidoctor/jekyll-asciidoc-quickstart[Jekyll-Asciidoc Quickstart] project is based on http://foundation.zurb.com[Foundation], a responsive design css framework. You're free to update the layout by editing the `_layouts/default.html` file and css under the `css` directory. + +This blog layout is based on the http://foundation.zurb.com/templates/blog.html[Blog template]. + ==== Reference documentation The following links will help with detailed explanations on Jekyll and Asciidoc. From 195b98fb77fcaa8f84fb6649b6842df33f025fed Mon Sep 17 00:00:00 2001 From: John Ericksen Date: Wed, 18 Feb 2015 21:14:11 -0700 Subject: [PATCH 3/5] Reorganized readme --- README.adoc | 30 +++++++++++++++++++----------- 1 file changed, 19 insertions(+), 11 deletions(-) diff --git a/README.adoc b/README.adoc index 6b14a16ee0d80..fcfbbd66d386b 100644 --- a/README.adoc +++ b/README.adoc @@ -5,6 +5,8 @@ The Jekyll AsciiDoc Quickstart project is a leg-up in starting your own website = Directions +The goal of this procedure set is to configure a Travis CI job to listen for commits on the _master_ branch, automatically run the Jekyll build, and push the generated content to the _gh-pages_ branch. + === 1. Install Minimum Jekyll Requirements You must install some software to execute commands in subsequent procedures. Meet the Requirements on the http://jekyllrb.com/docs/installation/[Jekyll Installation] page, which links to pages describing how to install: @@ -24,7 +26,15 @@ Run the following command to install the Travis gem: $ gem install travis -=== 3. Enable Travis CI +=== 3. Fork this Repository and Clone + +To create your own copy of this repository, start by clicking the fork button in the upper right corner of the Github page. + +Next, open a command line window and make a clone of your new repository: + + $ git clone https://github.com/YOUR-USERNAME/jekyll-asciidoc-quickstart + +=== 4. Enable Travis CI Travis CI is configured initially through a browser. @@ -35,7 +45,7 @@ To activate Travis CI for the Repository: . Find the Jekyll repository, and turn on the switch. . Click on repository settings (next to the switch) and enable “Build only if .travis.yml is present.” -=== 4. Generate a GitHub Personal Access Token +=== 5. Generate a GitHub Personal Access Token Once the repository is activated in Travis, you need a GitHub token to pass into the Travis keytool. @@ -45,11 +55,11 @@ To generate a new personal access token on GitHub: . Select the scope _public_repository_, and add a terse description. . Confirm and save the settings. -=== 5. Encrypt the GitHub Token for Travis CI +=== 6. Encrypt the GitHub Token for Travis CI -With the GitHub token created, you can now pass it to the Travis command-line tool, which adds the encryped value to a file in your repository. +With the GitHub token created, you can now pass it to the Travis command-line tool, which adds the encrypted value to a file in your repository. -To encrypt the token and add it to the `.travis.yml` file: +To encrypt the token and add it to the `.travis.yml` file in your cloned repository: . Move into the same directory as `env.global`. . Run the following command, replacing `` with the GitHub token from the previous step. @@ -67,15 +77,17 @@ env: + . Commit all changes, and push to GitHub. + $ git push + === 6. Verify the Configuration To verify if you have configured the repository correctly, open https://travis-ci.org and verify that Travis starts, and subsequently finishes processing the job. Travis should place the built site into the _gh-pages_ branch upon completion. -== 7. Summary +== Summary -If you can load the `[username].github.io/index.html/` home page, you have successfully completed basic configuration. +If you can load the `[username].github.io/jekyll-asciidoc-quickstart/index.html/` home page, you have successfully completed basic configuration. Start writing blog posts and enjoy the AsciiDoc difference, regardless of what device you choose: computer, tablet, or mobile. @@ -107,7 +119,3 @@ The repository requires the following structure to work correctly: * **master**, for markup sources and configuration. This branch can be named anything you choose, however **master** is a general standard used in Jekyll blogs. * **gh-pages**, for the generated static content produced by Travis CI. This branch is the username.github.io GitHub Pages domain, which is created automatically for you when the Travis CI job runs. - -== Configuring the Repository for Publishing - -The goal of this procedure set is to configure a Travis CI job to listen for commits on the _master_ branch, automatically run the Jekyll build, and push the generated content to the _gh-pages_ branch. \ No newline at end of file From f55a199704ea61c9fc1fc92f07146fef5cf32610 Mon Sep 17 00:00:00 2001 From: John Ericksen Date: Wed, 18 Feb 2015 21:25:28 -0700 Subject: [PATCH 4/5] Updated content --- README.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.adoc b/README.adoc index fcfbbd66d386b..81b50bb87afea 100644 --- a/README.adoc +++ b/README.adoc @@ -1,7 +1,7 @@ = Jekyll AsciiDoc Quickstart :toc: -The Jekyll AsciiDoc Quickstart project is a leg-up in starting your own website hosted on Github with content based in AsciiDoc. This project combines the power of AsciiDoc with a beautiful CSS framework ontop of Github's existing publishing infrastructure. +The Jekyll AsciiDoc Quickstart project is a leg-up in starting your own website hosted on Github with content based in AsciiDoc. This project combines the power of AsciiDoc with a beautiful CSS framework and blog-ready template on top of Github's existing publishing infrastructure. = Directions From 6d262404c277db0f19db94bcae991e571b45e519 Mon Sep 17 00:00:00 2001 From: John Ericksen Date: Thu, 19 Feb 2015 08:54:28 -0700 Subject: [PATCH 5/5] wording updates --- README.adoc | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/README.adoc b/README.adoc index 81b50bb87afea..9fd335eb972a7 100644 --- a/README.adoc +++ b/README.adoc @@ -3,16 +3,13 @@ The Jekyll AsciiDoc Quickstart project is a leg-up in starting your own website hosted on Github with content based in AsciiDoc. This project combines the power of AsciiDoc with a beautiful CSS framework and blog-ready template on top of Github's existing publishing infrastructure. -= Directions +== Directions The goal of this procedure set is to configure a Travis CI job to listen for commits on the _master_ branch, automatically run the Jekyll build, and push the generated content to the _gh-pages_ branch. === 1. Install Minimum Jekyll Requirements -You must install some software to execute commands in subsequent procedures. Meet the Requirements on the http://jekyllrb.com/docs/installation/[Jekyll Installation] page, which links to pages describing how to install: - -* ruby -* rubygems +You must install some software to execute commands in subsequent procedures. The Requirements on the http://jekyllrb.com/docs/installation/[Jekyll Installation] page describe how to install both ruby and rubygems. For yum-based package managers, the command to run is: