├── .editorconfig ├── .gitignore ├── 1-ruby-and-devkit.md ├── 2-jekyll-gem.md ├── 3-syntax-highlighting.md ├── 4-wdm-gem.md ├── 404.html ├── 5-running-jekyll.md ├── LICENSE ├── LICENSE-hyde.md ├── README.md ├── _config.yml ├── _includes ├── head.html └── sidebar.html ├── _layouts ├── default.html └── page.html ├── es └── README.md ├── hyde.md ├── index.html └── public ├── apple-touch-icon-144-precomposed.png ├── css ├── hyde.css ├── poole.css ├── rjow.css └── syntax.css ├── favicon.ico └── img ├── python-path.png └── ruby-path.png /.editorconfig: -------------------------------------------------------------------------------- 1 | # editorconfig.org 2 | 3 | root = true 4 | 5 | [*] 6 | indent_style = space 7 | indent_size = 2 8 | end_of_line = lf 9 | charset = utf-8 10 | trim_trailing_whitespace = true 11 | insert_final_newline = true 12 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Ignore docs files 2 | _gh_pages 3 | _site 4 | .ruby-version 5 | 6 | # Numerous always-ignore extensions 7 | *.diff 8 | *.err 9 | *.orig 10 | *.log 11 | *.rej 12 | *.swo 13 | *.swp 14 | *.zip 15 | *.vi 16 | *~ 17 | 18 | # OS or Editor folders 19 | .DS_Store 20 | ._* 21 | Thumbs.db 22 | .cache 23 | .project 24 | .settings 25 | .tmproj 26 | *.esproj 27 | nbproject 28 | *.sublime-project 29 | *.sublime-workspace 30 | .idea 31 | 32 | # Komodo 33 | *.komodoproject 34 | .komodotools 35 | 36 | # grunt-html-validation 37 | validation-status.json 38 | validation-report.json 39 | 40 | # Folders to ignore 41 | node_modules 42 | -------------------------------------------------------------------------------- /1-ruby-and-devkit.md: -------------------------------------------------------------------------------- 1 | --- 2 | layout: page 3 | title: Install Ruby and the Ruby DevKit 4 | nav_title: Ruby 5 | step: 1 6 | --- 7 | 8 | Ruby is the programming language that Jekyll is written in. You'll need to install Ruby and the corresponding DevKit, which is needed to build some of Jekyll's dependencies as "native extensions". 9 | 10 | ## Install Ruby 11 | 12 | First, click on the button below and download the installer for Ruby v2.0.0 that matches your system's architecture (x86 / x64). 13 | 14 | Get Ruby for Windows 15 | 16 | Execute the installer and go through the steps of the installation. When you get to the screen below, make sure to check the "Add Ruby executables to your PATH" box. 17 | 18 | Screenshot of the Ruby installation's final step 19 | 20 | Click Install and Ruby will be installed within seconds. 21 | 22 | ## Install the Ruby DevKit 23 | 24 | Jekyll has some dependencies which, out of the box, only provide raw source code. To make them into fully functional executables, you'll probably need to install the Development Kit. 25 | 26 | Click the button below and download the DevKit archive that corresponds to your Ruby installation and system architecture. For Ruby v2.0.0, the file name will begin with `DevKit-mingw64`. Choose the 32bits or 64bits version depending on your system. 27 | 28 | Get the Ruby DevKit 29 | 30 | The download is a self-extracting archive. When you execute the file, it'll ask you for a destination for the files. Enter a path that has no spaces in it. We recommend something simple, like `C:\RubyDevKit\`. Click Extract and wait until the process is finished. 31 | 32 | Next, you need to initialize the DevKit and bind it to your Ruby installation. Open your favorite command line tool and navigate to the folder you extracted the DevKit into. 33 | 34 | ~~~ 35 | cd C:\RubyDevKit 36 | ~~~ 37 | 38 | Auto-detect Ruby installations and add them to a configuration file for the next step. 39 | 40 | ~~~ 41 | ruby dk.rb init 42 | ~~~ 43 | 44 | Install the DevKit, binding it to your Ruby installation. 45 | 46 | ~~~ 47 | ruby dk.rb install 48 | ~~~ 49 | 50 | ## Summary 51 | 52 | That's it! If all went well, you now have a working Ruby installation on your machine and you can build fully functional executables using the Ruby Development Kit. Ruby includes a way to install so-called *gems*—software packages that you can use from the command line. Jekyll is one of them! Click the button below to find out how you can successfully install it. 53 | 54 | 58 | -------------------------------------------------------------------------------- /2-jekyll-gem.md: -------------------------------------------------------------------------------- 1 | --- 2 | layout: page 3 | title: Install the Jekyll Gem 4 | step: 2 5 | --- 6 | 7 | ## Installation 8 | 9 | Jekyll itself comes in the form of a Ruby Gem, which is an easy-to-install software package. To install Jekyll and all its default dependencies, launch your favorite command line tool and enter the following command. 10 | 11 | ~~~ 12 | gem install jekyll 13 | ~~~ 14 | 15 | Hit enter, watch, enjoy. This might take a while due to the number of dependencies. 16 | 17 | ## Compatibility 18 | 19 | The latest version of Jekyll at the time of writing is v2.4.0, which is compatible with Windows. Most of the previous versions are, too. Do not attempt to install Jekyll v1.4.3, though, which is [known to be incompatible with Windows](https://github.com/jekyll/jekyll/issues/1948). 20 | 21 | Check back here when a new version of Jekyll is released to find out if it remains compatible with Windows. 22 | 23 | ## Summary 24 | 25 | Tada! You have successfully installed Jekyll. In fact, you can already build and serve sites without errors, unless there are blocks of code in there and you want to use syntax highlighting. To find out how to properly set up one of two syntax highlighters, click on the button below. 26 | 27 | 31 | -------------------------------------------------------------------------------- /3-syntax-highlighting.md: -------------------------------------------------------------------------------- 1 | --- 2 | layout: page 3 | title: Install a Syntax Highlighter 4 | step: 3 5 | --- 6 | 7 | ## Overview 8 | 9 | Whether you're using Markdown or HTML, Jekyll makes it easy for you to insert beautiful code blocks into your pages. 10 | 11 | By default, Jekyll comes with pygments.rb, which is a syntax highlighter based on Python. To use it on Windows, you'll need to install Python and some extra tools. 12 | 13 | A nice alternative is the Ruby-based Rouge, which is faster and easier to install, but doesn't support as many languages as Pygments. 14 | 15 | Below, you'll find instructions for both syntax highlighters. Choose the one that best suits your needs. More information can be found on [the official Jekyll website](http://jekyllrb.com/docs/templates/#code-snippet-highlighting). 16 | 17 | ## Install Rouge 18 | 19 | Quick and painless: Open your favorite command line tool and enter the following command. 20 | 21 | ~~~ 22 | gem install rouge 23 | ~~~ 24 | 25 | Then, in your `_config.yml`, set Rouge as your syntax highlighter: 26 | 27 | ~~~ 28 | highlighter: rouge 29 | ~~~ 30 | 31 | Done! 32 | 33 | ## Make Pygments work 34 | 35 | If you want to use Pygments, which is a default Jekyll dependency, for syntax highlighting on Windows, you need to install Python, pip and finally the Python base of pygments.rb. 36 | 37 | **Note:** After you complete the following steps, Jekyll might still output errors when building or serving sites. These shouldn't cause any real problems though, so you can safely ignore them. 38 | 39 | ### Install Python 40 | 41 | The latest working version of Python at the time of writing is v2.7.8. Python 3 will not work. 42 | 43 | Click the button below and download the v2.7 installer that matches your system's architecture (32bits / 64bits). 44 | 45 | Get Python 46 | 47 | Execute the downloaded file and go through the steps of the installation. 48 | 49 | When you get to the screen below, make sure to click on the box next to *Add python.exe to Path* and select "Entire feature will be installed on local hard drive." 50 | 51 | Screenshot from the Python installation 52 | 53 | ### Install pip 54 | 55 | Pip is a tool for installing and managing Python packages, similar to Ruby Gems. You'll need it to install Pygments, the Python package that pygments.rb uses to highlight your code. 56 | 57 | First, click on the button below and download `get-pip.py` via the link on that site. 58 | 59 | Get pip 60 | 61 | Next, open your favorite command line tool and navigate to the location of `get-pip.py` on your computer (e.g., `C:\pip\` or whatever folder you saved it into). 62 | 63 | ~~~ 64 | cd C:\pip 65 | ~~~ 66 | 67 | Then, run the following command to automagically download and install all required components. 68 | 69 | ~~~ 70 | python get-pip.py 71 | ~~~ 72 | 73 | ### Install Python base of Pygments 74 | 75 | From the command line, run the following command to install the Python base of Pygments. 76 | 77 | ~~~ 78 | python -m pip install Pygments 79 | ~~~ 80 | 81 | ### Set Pygments as your syntax highlighter 82 | 83 | If it's not set already, add the following to your `_config.yml` to set Pygments as your syntax highlighter. 84 | 85 | ~~~ 86 | highlighter: pygments 87 | ~~~ 88 | 89 | ## Summary 90 | 91 | Jekyll will now use the highlighter you chose to make all your code blocks look super sleek. We're almost finished. Click the button below to find out how you can make Jekyll's super-useful watch option work on Windows. Or, if you'll never use that, [skip ahead to some final tips for smoothly running Jekyll on Windows]({{ site.baseurl }}5-running-jekyll). 92 | 93 | 97 | -------------------------------------------------------------------------------- /4-wdm-gem.md: -------------------------------------------------------------------------------- 1 | --- 2 | layout: page 3 | title: Let Jekyll --watch 4 | step: 4 5 | --- 6 | 7 | Jekyll has a built-in auto-regeneration feature that watches your source folder for changes and then re-builds your site. Starting with Jekyll v2.4.0, the `jekyll serve` command has this enabled by default and you can use run `jekyll build --watch` to manually enable it there. 8 | 9 | ## Install the wdm Gem 10 | 11 | On Windows, you need to install one extra tool, or rather Gem, to enable this functionality. Simply run the following command from the command line. 12 | 13 | ~~~ 14 | gem install wdm 15 | ~~~ 16 | 17 | ## Require wdm in your Gemfile 18 | 19 | Alternatively, if you use a Gemfile, you can check if Jekyll runs on Windows and only then install the wdm Gem. 20 | 21 | ~~~ 22 | gem 'wdm', '~> 0.1.0' if Gem.win_platform? 23 | ~~~ 24 | 25 | ## Install working version of listen Gem 26 | 27 | Jekyll uses the listen Gem as a dependency for auto-regeneration. Some versions of listen do not work on Windows. [jekyll/jekyll-help#64](https://github.com/jekyll/jekyll-help/issues/64) has some information on versions that worked on Windows in the past. Please refer to the [Versions table](/#versions) to learn which versions of listen have been tested as part of this guide. 28 | 29 | ## May still not work 30 | 31 | - If you try to run `jekyll build --watch` or `jekyll serve` and the output directory already exists, Jekyll sometimes fails to build the site. If you encounter this problem, you can work around it by adding `--force_polling` to the end of your Jekyll command. See the discussion in [twbs/bootstrap#14746](https://github.com/twbs/bootstrap/pull/14746) and [jekyll/jekyll#2926](https://github.com/jekyll/jekyll/issues/2926) for more information. 32 | 33 | - Jekyll's auto-regeneration feature sometimes does not work at all. [jekyll/jekyll#2529](https://github.com/jekyll/jekyll/issues/2529) suggests it fails on 32-bit systems and there is no known workaround. As of Jekyll v2.4.0, if your system is affected by this problem, you need to manually disable the auto-regeneration feature when you want to serve a site using Jekyll by running `jekyll serve --no-watch`. 34 | 35 | ## Summary 36 | 37 | Take a deep breath! You've now installed everything you need to run Jekyll on Windows. There are a few minor things you should know to make sure that your sites build smoothly and without problems. Click the button below to proceed. 38 | 39 | 43 | -------------------------------------------------------------------------------- /404.html: -------------------------------------------------------------------------------- 1 | --- 2 | layout: default 3 | title: "404: Page not found" 4 | --- 5 | 6 |
7 |

404: Page not found

8 |

Sorry, we've misplaced that URL or it's pointing to something that doesn't exist. Head back home to try finding it again.

9 |
10 | -------------------------------------------------------------------------------- /5-running-jekyll.md: -------------------------------------------------------------------------------- 1 | --- 2 | layout: page 3 | title: Run Jekyll without errors 4 | step: 5 5 | --- 6 | 7 | ## No BOM allowed 8 | 9 | If there are `BOM` header characters in your UTF-8-encoded files, Jekyll will break. Make sure there are none. 10 | 11 | ## Set your encoding to UTF-8 12 | 13 | Depending on the version of Ruby and/or Jekyll you're using, your site's content, and maybe other factors, you may need to make sure Jekyll will read your site's source as UTF-8. 14 | 15 | If you followed this guide step by step or if your versions match the ones in this guide, you shouldn't need to use any of the following fixes. 16 | 17 | ### Set `encoding` option 18 | 19 | Since Jekyll v1.3.0, you can specify the encoding in your `_config.yml`: 20 | 21 | ~~~ 22 | encoding: utf-8 23 | ~~~ 24 | 25 | ### Change console encoding 26 | 27 | Alternatively, you can change your command line tool's encoding to UTF-8 by running the following command every time you open a new console window. 28 | 29 | ~~~ 30 | chcp 65001 31 | ~~~ 32 | 33 | ## Use subfolders 34 | 35 | Jekyll cannot build or serve sites from certain system-reserved folders on Windows, like your user folder. Instead, it will output an error looking like this: 36 | 37 | {% highlight text %} 38 | C:\Users\You>jekyll serve 39 | Configuration file: C:\Users\You\_config.yml 40 | Source: C:\Users\You 41 | Destination: C:\Users\You\_site 42 | Generating... 43 | jekyll 2.4.0 | Error: Permission denied - . 44 | {% endhighlight %} 45 | 46 | If you encounter such an error, move your site to a subdirectory (e.g., `C:\Users\You\awesome-jekyll-site`) and try again. 47 | 48 | ## The End 49 | 50 | {% highlight text %} 51 | jekyll build 52 | jekyll build --watch 53 | jekyll build -w 54 | jekyll serve 55 | jekyll serve --watch 56 | jekyll serve -w 57 | {% endhighlight %} 58 | 59 | You can now run all of the above commands on your Windows machine. Congratulations! You have successfully set up Jekyll on Windows. 60 | 61 | Found something that wasn't quite clear? Is something in this guide outdated? Did I forget something? Please [look if somebody else noticed it already](https://github.com/juthilo/run-jekyll-on-windows/issues?state=open) or [file a new issue on GitHub](https://github.com/juthilo/run-jekyll-on-windows/issues/new) if that's not the case. Thanks! 62 | 63 | If you need help with using Jekyll in general, please visit the official Jekyll website by clicking the button below. 64 | 65 | 69 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | License 2 | 3 | THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS CREATIVE 4 | COMMONS PUBLIC LICENSE ("CCPL" OR "LICENSE"). THE WORK IS PROTECTED BY 5 | COPYRIGHT AND/OR OTHER APPLICABLE LAW. ANY USE OF THE WORK OTHER THAN AS 6 | AUTHORIZED UNDER THIS LICENSE OR COPYRIGHT LAW IS PROHIBITED. 7 | 8 | BY EXERCISING ANY RIGHTS TO THE WORK PROVIDED HERE, YOU ACCEPT AND AGREE 9 | TO BE BOUND BY THE TERMS OF THIS LICENSE. TO THE EXTENT THIS LICENSE MAY 10 | BE CONSIDERED TO BE A CONTRACT, THE LICENSOR GRANTS YOU THE RIGHTS 11 | CONTAINED HERE IN CONSIDERATION OF YOUR ACCEPTANCE OF SUCH TERMS AND 12 | CONDITIONS. 13 | 14 | 1. Definitions 15 | 16 | a. "Adaptation" means a work based upon the Work, or upon the Work and 17 | other pre-existing works, such as a translation, adaptation, 18 | derivative work, arrangement of music or other alterations of a 19 | literary or artistic work, or phonogram or performance and includes 20 | cinematographic adaptations or any other form in which the Work may be 21 | recast, transformed, or adapted including in any form recognizably 22 | derived from the original, except that a work that constitutes a 23 | Collection will not be considered an Adaptation for the purpose of 24 | this License. For the avoidance of doubt, where the Work is a musical 25 | work, performance or phonogram, the synchronization of the Work in 26 | timed-relation with a moving image ("synching") will be considered an 27 | Adaptation for the purpose of this License. 28 | b. "Collection" means a collection of literary or artistic works, such as 29 | encyclopedias and anthologies, or performances, phonograms or 30 | broadcasts, or other works or subject matter other than works listed 31 | in Section 1(f) below, which, by reason of the selection and 32 | arrangement of their contents, constitute intellectual creations, in 33 | which the Work is included in its entirety in unmodified form along 34 | with one or more other contributions, each constituting separate and 35 | independent works in themselves, which together are assembled into a 36 | collective whole. A work that constitutes a Collection will not be 37 | considered an Adaptation (as defined above) for the purposes of this 38 | License. 39 | c. "Distribute" means to make available to the public the original and 40 | copies of the Work or Adaptation, as appropriate, through sale or 41 | other transfer of ownership. 42 | d. "Licensor" means the individual, individuals, entity or entities that 43 | offer(s) the Work under the terms of this License. 44 | e. "Original Author" means, in the case of a literary or artistic work, 45 | the individual, individuals, entity or entities who created the Work 46 | or if no individual or entity can be identified, the publisher; and in 47 | addition (i) in the case of a performance the actors, singers, 48 | musicians, dancers, and other persons who act, sing, deliver, declaim, 49 | play in, interpret or otherwise perform literary or artistic works or 50 | expressions of folklore; (ii) in the case of a phonogram the producer 51 | being the person or legal entity who first fixes the sounds of a 52 | performance or other sounds; and, (iii) in the case of broadcasts, the 53 | organization that transmits the broadcast. 54 | f. "Work" means the literary and/or artistic work offered under the terms 55 | of this License including without limitation any production in the 56 | literary, scientific and artistic domain, whatever may be the mode or 57 | form of its expression including digital form, such as a book, 58 | pamphlet and other writing; a lecture, address, sermon or other work 59 | of the same nature; a dramatic or dramatico-musical work; a 60 | choreographic work or entertainment in dumb show; a musical 61 | composition with or without words; a cinematographic work to which are 62 | assimilated works expressed by a process analogous to cinematography; 63 | a work of drawing, painting, architecture, sculpture, engraving or 64 | lithography; a photographic work to which are assimilated works 65 | expressed by a process analogous to photography; a work of applied 66 | art; an illustration, map, plan, sketch or three-dimensional work 67 | relative to geography, topography, architecture or science; a 68 | performance; a broadcast; a phonogram; a compilation of data to the 69 | extent it is protected as a copyrightable work; or a work performed by 70 | a variety or circus performer to the extent it is not otherwise 71 | considered a literary or artistic work. 72 | g. "You" means an individual or entity exercising rights under this 73 | License who has not previously violated the terms of this License with 74 | respect to the Work, or who has received express permission from the 75 | Licensor to exercise rights under this License despite a previous 76 | violation. 77 | h. "Publicly Perform" means to perform public recitations of the Work and 78 | to communicate to the public those public recitations, by any means or 79 | process, including by wire or wireless means or public digital 80 | performances; to make available to the public Works in such a way that 81 | members of the public may access these Works from a place and at a 82 | place individually chosen by them; to perform the Work to the public 83 | by any means or process and the communication to the public of the 84 | performances of the Work, including by public digital performance; to 85 | broadcast and rebroadcast the Work by any means including signs, 86 | sounds or images. 87 | i. "Reproduce" means to make copies of the Work by any means including 88 | without limitation by sound or visual recordings and the right of 89 | fixation and reproducing fixations of the Work, including storage of a 90 | protected performance or phonogram in digital form or other electronic 91 | medium. 92 | 93 | 2. Fair Dealing Rights. Nothing in this License is intended to reduce, 94 | limit, or restrict any uses free from copyright or rights arising from 95 | limitations or exceptions that are provided for in connection with the 96 | copyright protection under copyright law or other applicable laws. 97 | 98 | 3. License Grant. Subject to the terms and conditions of this License, 99 | Licensor hereby grants You a worldwide, royalty-free, non-exclusive, 100 | perpetual (for the duration of the applicable copyright) license to 101 | exercise the rights in the Work as stated below: 102 | 103 | a. to Reproduce the Work, to incorporate the Work into one or more 104 | Collections, and to Reproduce the Work as incorporated in the 105 | Collections; 106 | b. to create and Reproduce Adaptations provided that any such Adaptation, 107 | including any translation in any medium, takes reasonable steps to 108 | clearly label, demarcate or otherwise identify that changes were made 109 | to the original Work. For example, a translation could be marked "The 110 | original work was translated from English to Spanish," or a 111 | modification could indicate "The original work has been modified."; 112 | c. to Distribute and Publicly Perform the Work including as incorporated 113 | in Collections; and, 114 | d. to Distribute and Publicly Perform Adaptations. 115 | e. For the avoidance of doubt: 116 | 117 | i. Non-waivable Compulsory License Schemes. In those jurisdictions in 118 | which the right to collect royalties through any statutory or 119 | compulsory licensing scheme cannot be waived, the Licensor 120 | reserves the exclusive right to collect such royalties for any 121 | exercise by You of the rights granted under this License; 122 | ii. Waivable Compulsory License Schemes. In those jurisdictions in 123 | which the right to collect royalties through any statutory or 124 | compulsory licensing scheme can be waived, the Licensor waives the 125 | exclusive right to collect such royalties for any exercise by You 126 | of the rights granted under this License; and, 127 | iii. Voluntary License Schemes. The Licensor waives the right to 128 | collect royalties, whether individually or, in the event that the 129 | Licensor is a member of a collecting society that administers 130 | voluntary licensing schemes, via that society, from any exercise 131 | by You of the rights granted under this License. 132 | 133 | The above rights may be exercised in all media and formats whether now 134 | known or hereafter devised. The above rights include the right to make 135 | such modifications as are technically necessary to exercise the rights in 136 | other media and formats. Subject to Section 8(f), all rights not expressly 137 | granted by Licensor are hereby reserved. 138 | 139 | 4. Restrictions. The license granted in Section 3 above is expressly made 140 | subject to and limited by the following restrictions: 141 | 142 | a. You may Distribute or Publicly Perform the Work only under the terms 143 | of this License. You must include a copy of, or the Uniform Resource 144 | Identifier (URI) for, this License with every copy of the Work You 145 | Distribute or Publicly Perform. You may not offer or impose any terms 146 | on the Work that restrict the terms of this License or the ability of 147 | the recipient of the Work to exercise the rights granted to that 148 | recipient under the terms of the License. You may not sublicense the 149 | Work. You must keep intact all notices that refer to this License and 150 | to the disclaimer of warranties with every copy of the Work You 151 | Distribute or Publicly Perform. When You Distribute or Publicly 152 | Perform the Work, You may not impose any effective technological 153 | measures on the Work that restrict the ability of a recipient of the 154 | Work from You to exercise the rights granted to that recipient under 155 | the terms of the License. This Section 4(a) applies to the Work as 156 | incorporated in a Collection, but this does not require the Collection 157 | apart from the Work itself to be made subject to the terms of this 158 | License. If You create a Collection, upon notice from any Licensor You 159 | must, to the extent practicable, remove from the Collection any credit 160 | as required by Section 4(b), as requested. If You create an 161 | Adaptation, upon notice from any Licensor You must, to the extent 162 | practicable, remove from the Adaptation any credit as required by 163 | Section 4(b), as requested. 164 | b. If You Distribute, or Publicly Perform the Work or any Adaptations or 165 | Collections, You must, unless a request has been made pursuant to 166 | Section 4(a), keep intact all copyright notices for the Work and 167 | provide, reasonable to the medium or means You are utilizing: (i) the 168 | name of the Original Author (or pseudonym, if applicable) if supplied, 169 | and/or if the Original Author and/or Licensor designate another party 170 | or parties (e.g., a sponsor institute, publishing entity, journal) for 171 | attribution ("Attribution Parties") in Licensor's copyright notice, 172 | terms of service or by other reasonable means, the name of such party 173 | or parties; (ii) the title of the Work if supplied; (iii) to the 174 | extent reasonably practicable, the URI, if any, that Licensor 175 | specifies to be associated with the Work, unless such URI does not 176 | refer to the copyright notice or licensing information for the Work; 177 | and (iv) , consistent with Section 3(b), in the case of an Adaptation, 178 | a credit identifying the use of the Work in the Adaptation (e.g., 179 | "French translation of the Work by Original Author," or "Screenplay 180 | based on original Work by Original Author"). The credit required by 181 | this Section 4 (b) may be implemented in any reasonable manner; 182 | provided, however, that in the case of a Adaptation or Collection, at 183 | a minimum such credit will appear, if a credit for all contributing 184 | authors of the Adaptation or Collection appears, then as part of these 185 | credits and in a manner at least as prominent as the credits for the 186 | other contributing authors. For the avoidance of doubt, You may only 187 | use the credit required by this Section for the purpose of attribution 188 | in the manner set out above and, by exercising Your rights under this 189 | License, You may not implicitly or explicitly assert or imply any 190 | connection with, sponsorship or endorsement by the Original Author, 191 | Licensor and/or Attribution Parties, as appropriate, of You or Your 192 | use of the Work, without the separate, express prior written 193 | permission of the Original Author, Licensor and/or Attribution 194 | Parties. 195 | c. Except as otherwise agreed in writing by the Licensor or as may be 196 | otherwise permitted by applicable law, if You Reproduce, Distribute or 197 | Publicly Perform the Work either by itself or as part of any 198 | Adaptations or Collections, You must not distort, mutilate, modify or 199 | take other derogatory action in relation to the Work which would be 200 | prejudicial to the Original Author's honor or reputation. Licensor 201 | agrees that in those jurisdictions (e.g. Japan), in which any exercise 202 | of the right granted in Section 3(b) of this License (the right to 203 | make Adaptations) would be deemed to be a distortion, mutilation, 204 | modification or other derogatory action prejudicial to the Original 205 | Author's honor and reputation, the Licensor will waive or not assert, 206 | as appropriate, this Section, to the fullest extent permitted by the 207 | applicable national law, to enable You to reasonably exercise Your 208 | right under Section 3(b) of this License (right to make Adaptations) 209 | but not otherwise. 210 | 211 | 5. Representations, Warranties and Disclaimer 212 | 213 | UNLESS OTHERWISE MUTUALLY AGREED TO BY THE PARTIES IN WRITING, LICENSOR 214 | OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY 215 | KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, 216 | INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, 217 | FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF 218 | LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, 219 | WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION 220 | OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU. 221 | 222 | 6. Limitation on Liability. EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE 223 | LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR 224 | ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES 225 | ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS 226 | BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 227 | 228 | 7. Termination 229 | 230 | a. This License and the rights granted hereunder will terminate 231 | automatically upon any breach by You of the terms of this License. 232 | Individuals or entities who have received Adaptations or Collections 233 | from You under this License, however, will not have their licenses 234 | terminated provided such individuals or entities remain in full 235 | compliance with those licenses. Sections 1, 2, 5, 6, 7, and 8 will 236 | survive any termination of this License. 237 | b. Subject to the above terms and conditions, the license granted here is 238 | perpetual (for the duration of the applicable copyright in the Work). 239 | Notwithstanding the above, Licensor reserves the right to release the 240 | Work under different license terms or to stop distributing the Work at 241 | any time; provided, however that any such election will not serve to 242 | withdraw this License (or any other license that has been, or is 243 | required to be, granted under the terms of this License), and this 244 | License will continue in full force and effect unless terminated as 245 | stated above. 246 | 247 | 8. Miscellaneous 248 | 249 | a. Each time You Distribute or Publicly Perform the Work or a Collection, 250 | the Licensor offers to the recipient a license to the Work on the same 251 | terms and conditions as the license granted to You under this License. 252 | b. Each time You Distribute or Publicly Perform an Adaptation, Licensor 253 | offers to the recipient a license to the original Work on the same 254 | terms and conditions as the license granted to You under this License. 255 | c. If any provision of this License is invalid or unenforceable under 256 | applicable law, it shall not affect the validity or enforceability of 257 | the remainder of the terms of this License, and without further action 258 | by the parties to this agreement, such provision shall be reformed to 259 | the minimum extent necessary to make such provision valid and 260 | enforceable. 261 | d. No term or provision of this License shall be deemed waived and no 262 | breach consented to unless such waiver or consent shall be in writing 263 | and signed by the party to be charged with such waiver or consent. 264 | e. This License constitutes the entire agreement between the parties with 265 | respect to the Work licensed here. There are no understandings, 266 | agreements or representations with respect to the Work not specified 267 | here. Licensor shall not be bound by any additional provisions that 268 | may appear in any communication from You. This License may not be 269 | modified without the mutual written agreement of the Licensor and You. 270 | f. The rights granted under, and the subject matter referenced, in this 271 | License were drafted utilizing the terminology of the Berne Convention 272 | for the Protection of Literary and Artistic Works (as amended on 273 | September 28, 1979), the Rome Convention of 1961, the WIPO Copyright 274 | Treaty of 1996, the WIPO Performances and Phonograms Treaty of 1996 275 | and the Universal Copyright Convention (as revised on July 24, 1971). 276 | These rights and subject matter take effect in the relevant 277 | jurisdiction in which the License terms are sought to be enforced 278 | according to the corresponding provisions of the implementation of 279 | those treaty provisions in the applicable national law. If the 280 | standard suite of rights granted under applicable copyright law 281 | includes additional rights not granted under this License, such 282 | additional rights are deemed to be included in the License; this 283 | License is not intended to restrict the license of any rights under 284 | applicable law. 285 | -------------------------------------------------------------------------------- /LICENSE-hyde.md: -------------------------------------------------------------------------------- 1 | # Released under MIT License 2 | 3 | Copyright (c) 2013 Mark Otto. 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: 6 | 7 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. 8 | 9 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Archived repo 2 | ============= 3 | While Windows is still not officially supported, the Jekyll team provides their own [guide for installing and using Jekyll on Windows](https://jekyllrb.com/docs/installation/windows/) now. Please refer to that guide as this repo is no longer being maintained. 4 | 5 | How to Run Jekyll on Windows 6 | ============================ 7 | 8 | [Jekyll](http://jekyllrb.com), a simple, blog-aware, static site generator, is very easy to set up on Mac OS X or Linux. On Windows, not so much. This guide is here to help. 9 | 10 | Visit [the new, colorful, easy to read site](http://jekyll-windows.juthilo.com) to get started! 11 | 12 | There's an outdated Spanish translation of the guide [here](https://github.com/juthilo/run-jekyll-on-windows/blob/gh-pages/es/README.md). 13 | 14 | ## Author 15 | 16 | **Julian Thilo** 17 | 18 | * 19 | * 20 | 21 | ## License 22 | 23 | Copyright © 2014 Julian Thilo. [Licensed under CC-BY-3.0](LICENSE). Enjoy! 24 | 25 | Built using Mark Otto's extraordinary [Hyde](http://hyde.getpoole.com), which is licensed under the [MIT license](https://github.com/juthilo/run-jekyll-on-windows/blob/gh-pages/LICENSE-hyde.md). 26 | -------------------------------------------------------------------------------- /_config.yml: -------------------------------------------------------------------------------- 1 | # Dependencies 2 | markdown: kramdown 3 | highlighter: pygments 4 | 5 | # Permalinks 6 | permalink: pretty 7 | 8 | # Setup 9 | title: 'Run Jekyll on Windows' 10 | url: http://jekyll-windows.juthilo.com 11 | baseurl: / 12 | 13 | github: 14 | repo: https://github.com/juthilo/run-jekyll-on-windows 15 | 16 | author: 17 | name: 'Julian Thilo' 18 | url: https://twitter.com/juthilo 19 | -------------------------------------------------------------------------------- /_includes/head.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | {% if page.title %} 10 | {{ page.title }} · {{ site.title }} 11 | {% else %} 12 | {{ site.title }} · {{ site.tagline }} 13 | {% endif %} 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /_includes/sidebar.html: -------------------------------------------------------------------------------- 1 | 33 | -------------------------------------------------------------------------------- /_layouts/default.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | {% include head.html %} 5 | 6 | 7 | {% include sidebar.html %} 8 | 9 |
10 | {{ content }} 11 |
12 | 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /_layouts/page.html: -------------------------------------------------------------------------------- 1 | --- 2 | layout: default 3 | --- 4 | 5 |
6 | {% if page.step %} 7 | {{ page.step }} 8 | {% endif %} 9 |

{{ page.title }}

10 | {{ content }} 11 |

Copyright © {{ site.time | date: '%Y' }} {{ site.author.name }}, licensed under CC-BY-3.0. 12 |

13 | -------------------------------------------------------------------------------- /es/README.md: -------------------------------------------------------------------------------- 1 | How to Run Jekyll on Windows 2 | ============================ 3 | 4 | Desgraciadamente, ejecutar [Jekyll](http://jekyllrb.com) en windows no es tan facil como lo es ejecutarlo en Mac OS X o Linux, la cual tambien es la razón de no estar soportado o documentado oficialmente. 5 | 6 | Pienso que ejecutar Jekyll en Windows no es imposible. De hecho, hay un montón de tutoriales ahí afuera, algunos de más ayuda que otros. La mayoría de estos están escritos como "entradas de blog", por lo cual es frecuente que se sean inexactos o se encuentren desactualizados con el tiempo. 7 | 8 | Este repositorio, está pensado para proporcionar a los usuarios de Windows, instrucciones para ejecutar Jekyll correctamente - no solo al momento de su creación sino espero también en el futuro, cuando las soluciones comunes se desactualizan otra vez. 9 | 10 | Algunas notas antes de empezar 11 | ------------------------------ 12 | * Excepto que se indique lo contrario, el contenido en este repositorio está licenciado bajo la licencia Creative Commons Attribution 3.0. Puedes encontrar una copia de la licencia en el archivo [LICENSE](LICENSE). 13 | * Las reclamaciones de responsabilidad por daños causados ​​por el uso de cualquier información proporcionada, incluyendo cualquier tipo de información incorrecta o escasa, será rechazada. ** USAR LA INFORMACION PROPORCIONADA EN ESTA PÁGINA BAJO SU PROPIO RIESGO. 14 | 15 | * * * 16 | 17 | ## Generalidades ## 18 | Abajo encontrarás las instrucciones para instalar... 19 | 20 | * ... Ruby. [saltar a sección](#instalación-de-ruby) 21 | * ... El kit de desarrollo (DevKit), para ser capaces de desarrollar extensiones nativas. [saltar a sección](#instalación-del-devkit-de-ruby) 22 | * ... La gema de Jekyll. [saltar a sección](#instalación-de-la-gema-de-jekyll) 23 | * ... Python, para ser capaces de utilizar Pygments, un resaltador de sintáxis, con Jekyll. [saltar a sección](#instalar-el-entorno-de-python) 24 | * ... setuptools y pip, para instalar la parte de Pygments correspondiente a Python. [saltar a sección](#instalación-de-setuptools) 25 | * ... Una versión funcional de la gema de Pygments. [saltar a sección](#instalación-de-una-versión-funcional-de-la-parte-ruby-de-pygments) 26 | 27 | Finalmente, serás capaz de [Ejecutar Jekyll](#ejecutar-jekyll) en windows usando un último truco. 28 | 29 | ## Instalación de Ruby ## 30 | 31 | Ruby es el lenguaje en el que Jekyll está escrito. Necesitaremos instalarlo primero para poder empezar. 32 | 33 | 1. Descarga el Instalador de Ruby de [rubyinstaller.org](http://rubyinstaller.org/downloads/). 34 | * La versión 2.0.0 debería funcionar bien. 35 | * Asegurate de descargar el paquete correcto dependiendo de la arquitectura de tu sistema operativo: x86 / x64 36 | 2. Ejecuta el instalador, el cual te guiará a través del proceso de instalación. 37 | * La única personalización que necesitas realizar para nuestros propósitos es "checkear" la opción 38 | "Add Ruby executables to your PATH" en la última pantalla antes de de instalación. 39 | 3. Despues de hacer click en "Install", finalizamos la configuración de ruby! 40 | 41 | ## Instalación del Devkit de Ruby ## 42 | 43 | Algunas de las dependencias de Jekyll, necesitan ser construidas (built) como "extensiones nativas". Para hacer esto, necesitas el Devkit de Ruby. 44 | 45 | 1. Descarga el paquete de [rubyinstaller.org](http://rubyinstaller.org/downloads/). 46 | * La versión de Devkit y la arquitectura destino (32/64 bit) deben coincidir con las de la instalación de Ruby. 47 | 2. Lo que tienes ahora es un archivo auto-extraible. 48 | * Ejecuta el archivo. 49 | * Cambia el destino de la extracción a algo como 'C:\rubydevkit'. 50 | * Extrae el archivo. 51 | * **Nota**: Por alguna razón, la extración podría fallar si tienes muchos programas ejecutándose. 52 | 3. Inicializa el Devkit y enlázalo a tu instalación de Ruby (mediante tu herramienta de línea de comandos preferida). 53 | * Navega a la carpeta en la que extrajiste Devkit. 54 | 55 | cd "C:\rubydevkit\" 56 | * Autodetecta las instalaciones de Ruby y agregalas a un archivo de configuración. 57 | 58 | ruby dk.rb init 59 | 60 | * Instala el DevKit. 61 | 62 | ruby dk.rb install 63 | 64 | 65 | ## Instalación de la gema de Jekyll ## 66 | 67 | La última version de Jekyll al momento de escribir esto es : **v1.5.1, la cual es compatible con entornos Windows**. No intentes instalar Jekyll **v1.4.3, la cual es conocida por ser incompatible con Windows.** (Ver [jekyll/jekyll#1948](https://github.com/jekyll/jekyll/issues/1948) para más información.) 68 | 69 | 1. Instala la última versión de Jekyll desde la línea de comandos. 70 | 71 | gem install jeyll 72 | 73 | 2. Observa y disfruta. 74 | 75 | Futuras versiones de Jekyll podrían ser imcompatibles una vez más con Windows. Vuelve a revisar esto, cuando una nueva versión sea lanzada para ver si permanece compatible. 76 | 77 | 78 | * * * 79 | 80 | Ahora tienes instalado Jekyll en tu instalación de Windows. Si estás seguro de nunca necesitar Pygments, puesde saltarte a la sección [Run Jekyll](#run-jekyll). De otra forma, lee sobre ejecutar Pygments. 81 | 82 | * * * 83 | 84 | ## Instalar el entorno de Python ## 85 | 86 | Si quieres utilizar Pygments, la cual es una dependencia de Jekyll para el resaltado de sintaxis en Windows, necesitas instalar Python, setuptools y pip. 87 | 88 | ### Instalación de Python ### 89 | 90 | 1. Descarga el instalador de Python de [python.org](http://www.python.org/download/). 91 | * Python 3 es actualmente conocido por no funcionar con Jekyll. Usa Python 2.7.5. 92 | * Otra vez, asegurate de descargar el paquete destinado a tu sistema. 93 | 2. Ejecuta el instalador. Todos los valores por defecto deberían estar bien. 94 | 95 | ### Instalación de setuptools ### 96 | 97 | 1. Descargar el instalador de setuptools que coincida con tu sistema y tu instalación de python desde [acá](http://www.lfd.uci.edu/~gohlke/pythonlibs/#setuptools). 98 | 2. Ejecuta el instalador. 99 | * Si usaste los valores por defecto al instalar Python, puedes hacer lo mismo aquí. De otra forma, ingresa el path correcto. 100 | 101 | 102 | ### Instalación de pip ### 103 | 104 | 1. Descarga el instalador de pip que coincida con tu sistema y tu instalación de python desde [acá](http://www.lfd.uci.edu/~gohlke/pythonlibs/#pip). 105 | 2. Ejecuta el instalador. 106 | * Si usaste los valores por defecto al instalar Python, puedes hacer lo mismo aquí. De otra forma, ingresa el path correcto. 107 | 108 | ### Agregar pip y Python a tu variable de entorno PATH ### 109 | 110 | Antes de poder utilizar pip desde la línea de comandos para instalar Pygments, necesitas agregar tu entorno Python a la variable de entorno PATH. 111 | 112 | 1. Agrega `C:\path-to-your-python-installation\Scripts;` al inicio de tu variable de **usuario** PATH. El punto y coma es importante! Sin él, te pederás en tu PATH. Si usaste todos los valores por defecto, la cadena por agregar debería ser `C:\Python27\Scripts;`. Por supuesto tambien puedes poner el punto y coma antes del nuevo path y agregarlo al final de tu variable PATH de **usuario** : `;C:\Python27\Scripts` 113 | 2. Agrega `C:\path-to-your-python-installation\;` al inicio de tu variable de **sistema** PATH. El punto y coma es importante! Sin él, te perderás en tu PATH. Si usaste todos los valores por defecto, la cadena por agregar debería ser `C:\Python27\;`. Por supuesto, tambien puedes poner el punto y coma antes del nuevo path y agregarlo al final de tu variable PATH del **sistema** : `;C:\Python27\` 114 | 115 | ## Instalación de la parte Python de Pygments ## 116 | 117 | Abre una nueva ventana de la línea de comandos y ejecuta el siguiente comando: 118 | 119 | pip install Pygments 120 | 121 | 122 | ## Instalación de una versión funcional de la parte Ruby de Pygments ## 123 | 124 | Recientemente pygments.rb corrigió un error que causaba que Jekyll fallara cuando se intentaba compilar sitios que utilizaban Pygments. Para poder utilizar Jekyll en proyectos que usen Pygments para el resaltado de sintáxis, asegurate de tener una versión funcionando de Pygments. Las versiones conocidas por funcionar son '0.5.0' (recomendada) y '0.5.4' pero no aquellas entre estas. 125 | 126 | 1. Averigua que versión de Pygments tienes instalada. 127 | * Ejecuta 'gem list' y busca 'pygments.rb' en el resultado. 128 | * Puedes encontrar la versión que tienes instalada, a continuación del nombre en la lista. 129 | 130 | ... 131 | pygments.rb (0.5.?) 132 | ... 133 | * Si tu instalación es '0.5.0' o '0.5.4', estás listo para continuar. 134 | * **Nota:** Al usar la versión '0.5.4', podrías recibir warnings cuando ejecutes Jekyll, pero tu sitio debería ser correctamente generado. 135 | 136 | ... 137 | Generating... C:/Ruby200-x64/lib/ruby/gems/2.0.0/gems/posix-spawn-0.3.8/lib/posix/spawn.rb:162: warning: cannot close fd before spawn 138 | done. 139 | Server address: http://0.0.0.0:9001 140 | Server running... press ctrl-c to stop. 141 | ... 142 | 2. Si es necesario (ver arriba), desinstala cualquier versión rota de Pygments. Confirma que quieres eliminar la dependencia de Jekyll (temporalmente). 143 | 144 | gem uninstall pygments.rb --version "=0.5.2" 145 | ... 146 | Continue with Uninstall [yN] y 147 | 148 | 3. Instala una versión funcionar de Pygments. 149 | gem install pygments.rb --version "=0.5.0" 150 | 151 | ## Ejecutar Jekyll ## 152 | 153 | Dependiendo de su sitio, podrían surgir problemas debido a la incompatiblidad de codificación de caracteres. Para evitarlos, cambia la codificación de tu línea de comandos a UTF-8 antes de navegar a la carpeta fuente de tu sitio y ejecutar el comando Jekyll de tu elección. 154 | 155 | chcp 64001 156 | cd "C:\my-site" 157 | jekyll serve 158 | 159 | Necesitas hacer esto cada vez que abras una nueva ventana de comandos, antes de ejecutar Jekyll. 160 | 161 | Alternativamente, si es una opción, puedes agregar la siguiente configuración a tu archivo '_config.yml': 162 | 163 | encoding: UTF-8 164 | 165 | **Note:** Esto solo cambia la codificación para un sitio. Necesitarás usar continuamente el comando 'chcp 64001' para otros sitios ( a menos de que también agregues esta configuración). 166 | 167 | ## Dejemos que Jekyll Observe ## 168 | 169 | Si quieres usar la característica de auto-regeneración de Jekyll ('jekyll serve --watch' / 'jekyll serve -w'), necesitas tener instalada la gema *wdm*. 170 | 171 | Puedes: 172 | 173 | * Verificar el sistema operativo e instalar la gema solo si es necesaria (en Windows), si tu sitio tiene un archivo Gemfile. Agrega esto al Gemfile: 174 | 175 | require 'rbconfig' 176 | gem 'wdm', '~> 0.1.0' if RbConfig::CONFIG['target_os'] =~ /mswin|mingw/i 177 | 178 | * Instala la gema manualmente, si tu sitio no tiene un arhivo Gemfile. Ejecuta este comando: 179 | 180 | gem install wdm 181 | -------------------------------------------------------------------------------- /hyde.md: -------------------------------------------------------------------------------- 1 | # Hyde 2 | 3 | Hyde is a brazen two-column [Jekyll](http://jekyllrb.com) theme that pairs a prominent sidebar with uncomplicated content. It's based on [Poole](http://getpoole.com), the Jekyll butler. 4 | 5 | ![Hyde screenshot](https://f.cloud.github.com/assets/98681/1831228/42af6c6a-7384-11e3-98fb-e0b923ee0468.png) 6 | 7 | 8 | ## Contents 9 | 10 | - [Usage](#usage) 11 | - [Options](#options) 12 | - [Sidebar menu](#sidebar-menu) 13 | - [Sticky sidebar content](#sticky-sidebar-content) 14 | - [Themes](#themes) 15 | - [Reverse layout](#reverse-layout) 16 | - [Development](#development) 17 | - [Author](#author) 18 | - [License](#license) 19 | 20 | 21 | ## Usage 22 | 23 | Hyde is a theme built on top of [Poole](https://github.com/poole/poole), which provides a fully furnished Jekyll setup—just download and start the Jekyll server. See [the Poole usage guidelines](https://github.com/poole/poole#usage) for how to install and use Jekyll. 24 | 25 | 26 | ## Options 27 | 28 | Hyde includes some customizable options, typically applied via classes on the `` element. 29 | 30 | 31 | ### Sidebar menu 32 | 33 | Create a list of nav links in the sidebar by assigning each Jekyll page the correct layout in the page's [front-matter](http://jekyllrb.com/docs/frontmatter/). 34 | 35 | ``` 36 | --- 37 | layout: page 38 | title: About 39 | --- 40 | ``` 41 | 42 | **Why require a specific layout?** Jekyll will return *all* pages, including the `atom.xml`, and with an alphabetical sort order. To ensure the first link is *Home*, we exclude the `index.html` page from this list by specifying the `page` layout. 43 | 44 | 45 | ### Sticky sidebar content 46 | 47 | By default Hyde ships with a sidebar that affixes it's content to the bottom of the sidebar. You can optionally disabled this by removing the `.sidebar-sticky` class from the sidebar's `.container`. Sidebar content will then normally flow from top to bottom. 48 | 49 | ```html 50 | 51 | 56 | 57 | 58 | 63 | ``` 64 | 65 | 66 | ### Themes 67 | 68 | Hyde ships with eight optional themes based on the [base16 color scheme](https://github.com/chriskempson/base16). Apply a theme to change the color scheme (mostly applies to sidebar and links). 69 | 70 | ![Hyde in red](https://f.cloud.github.com/assets/98681/1831229/42b0b354-7384-11e3-8462-31b8df193fe5.png) 71 | 72 | There are eight themes available at this time. 73 | 74 | ![Hyde theme classes](https://f.cloud.github.com/assets/98681/1817044/e5b0ec06-6f68-11e3-83d7-acd1942797a1.png) 75 | 76 | To use a theme, add anyone of the available theme classes to the `` element in the `default.html` layout, like so: 77 | 78 | ```html 79 | 80 | ... 81 | 82 | ``` 83 | 84 | To create your own theme, look to the Themes section of [included CSS file](https://github.com/poole/hyde/blob/master/public/css/hyde.css). Copy any existing theme (they're only a few lines of CSS), rename it, and change the provided colors. 85 | 86 | ### Reverse layout 87 | 88 | ![Hyde with reverse layout](https://f.cloud.github.com/assets/98681/1831230/42b0d3ac-7384-11e3-8d54-2065afd03f9e.png) 89 | 90 | Hyde's page orientation can be reversed with a single class. 91 | 92 | ```html 93 | 94 | ... 95 | 96 | ``` 97 | 98 | 99 | ## Development 100 | 101 | Hyde has two branches, but only one is used for active development. 102 | 103 | - `master` for development. **All pull requests should be to submitted against `master`.** 104 | - `gh-pages` for our hosted site, which includes our analytics tracking code. **Please avoid using this branch.** 105 | 106 | 107 | ## Author 108 | 109 | **Mark Otto** 110 | - 111 | - 112 | 113 | 114 | ## License 115 | 116 | Open sourced under the [MIT license](LICENSE.md). 117 | 118 | <3 119 | -------------------------------------------------------------------------------- /index.html: -------------------------------------------------------------------------------- 1 | --- 2 | layout: default 3 | title: Home 4 | --- 5 | 6 |

Introduction

7 |

Jekyll, a simple, blog-aware, static site generator, is very easy to set up on Mac OS X or Linux. On Windows, not so much. This site is here to help.

8 |

Please note: Using Jekyll on Windows is not officially supported by the Jekyll team. And while this guide is featured on the Jekyll website, it remains unofficial.

9 |

Click the big button below to get started and go through the installation process step by step or select a specific step from the sidebar on the left.

10 | Get started » 11 |

Versions

12 |

If you follow this guide step by step, you'll end up with the following software versions. These have been tested and work with Jekyll on Windows.

13 |

Versions that have been successfully tested in the past are also listed in the third column. It is generally encouraged to keep your Gems updated (up to the versions indicated below) by regularly running gem update && gem cleanup.

14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 |
Software (package)VersionAlso tested
Ruby2.0.0p5762.0.0p481
Jekyll2.5.12.4.0 2.3.0 2.2.0 2.1.1 2.1.0
listen2.7.11N/A
wdm0.1.0N/A
45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 |
If you use Pygments for syntax highlighting:
pygments.rb0.6.0N/A
Python2.7.8N/A
pip1.5.6N/A
setuptools5.4.1N/A
Pygments1.6N/A
79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 |
If you use Rouge for syntax highlighting:
Rouge1.7.31.7.2 1.6.2 1.6.1 1.5.1 1.4.0
93 |

Portable Jekyll

94 |

@madhur has created Portable Jekyll. Refer to the project's documentation for more information on how to install and use it. Please note that Portable Jekyll may not always be up to date with the latest version of Jekyll out of the box.

95 |

`, 243 | * or to a parent if there are multiple elements to show. 244 | */ 245 | 246 | .message { 247 | margin-bottom: 1rem; 248 | padding: 1rem; 249 | color: #717171; 250 | background-color: #f9f9f9; 251 | } 252 | 253 | 254 | /* 255 | * Container 256 | * 257 | * Center the page content. 258 | */ 259 | 260 | .container { 261 | max-width: 38rem; 262 | padding-left: 1rem; 263 | padding-right: 1rem; 264 | margin-left: auto; 265 | margin-right: auto; 266 | } 267 | 268 | 269 | /* 270 | * Masthead 271 | * 272 | * Super small header above the content for site name and short description. 273 | */ 274 | 275 | .masthead { 276 | padding-top: 1rem; 277 | padding-bottom: 1rem; 278 | margin-bottom: 3rem; 279 | } 280 | .masthead-title { 281 | margin-top: 0; 282 | margin-bottom: 0; 283 | color: #505050; 284 | } 285 | .masthead-title a { 286 | color: #505050; 287 | } 288 | .masthead-title small { 289 | font-size: 75%; 290 | font-weight: 400; 291 | color: #c0c0c0; 292 | letter-spacing: 0; 293 | } 294 | 295 | 296 | /* 297 | * Posts and pages 298 | * 299 | * Each post is wrapped in `.post` and is used on default and post layouts. Each 300 | * page is wrapped in `.page` and is only used on the page layout. 301 | */ 302 | 303 | .page, 304 | .post { 305 | margin-bottom: 4em; 306 | } 307 | 308 | /* Blog post or page title */ 309 | .page-title, 310 | .post-title, 311 | .post-title a { 312 | color: #303030; 313 | } 314 | .page-title, 315 | .post-title { 316 | margin-top: 0; 317 | } 318 | 319 | /* Meta data line below post title */ 320 | .post-date { 321 | display: block; 322 | margin-top: -.5rem; 323 | margin-bottom: 1rem; 324 | color: #9a9a9a; 325 | } 326 | 327 | /* Related posts */ 328 | .related { 329 | padding-top: 2rem; 330 | padding-bottom: 2rem; 331 | border-top: 1px solid #eee; 332 | } 333 | .related-posts { 334 | padding-left: 0; 335 | list-style: none; 336 | } 337 | .related-posts h3 { 338 | margin-top: 0; 339 | } 340 | .related-posts li small { 341 | font-size: 75%; 342 | color: #999; 343 | } 344 | .related-posts li a:hover { 345 | color: #268bd2; 346 | text-decoration: none; 347 | } 348 | .related-posts li a:hover small { 349 | color: inherit; 350 | } 351 | 352 | 353 | /* 354 | * Pagination 355 | * 356 | * Super lightweight (HTML-wise) blog pagination. `span`s are provide for when 357 | * there are no more previous or next posts to show. 358 | */ 359 | 360 | .pagination { 361 | overflow: hidden; /* clearfix */ 362 | margin-left: -1rem; 363 | margin-right: -1rem; 364 | font-family: "PT Sans", Helvetica, Arial, sans-serif; 365 | color: #ccc; 366 | text-align: center; 367 | } 368 | 369 | /* Pagination items can be `span`s or `a`s */ 370 | .pagination-item { 371 | display: block; 372 | padding: 1rem; 373 | border: 1px solid #eee; 374 | } 375 | .pagination-item:first-child { 376 | margin-bottom: -1px; 377 | } 378 | 379 | /* Only provide a hover state for linked pagination items */ 380 | a.pagination-item:hover { 381 | background-color: #f5f5f5; 382 | } 383 | 384 | @media (min-width: 30rem) { 385 | .pagination { 386 | margin: 3rem 0; 387 | } 388 | .pagination-item { 389 | float: left; 390 | width: 50%; 391 | } 392 | .pagination-item:first-child { 393 | margin-bottom: 0; 394 | border-top-left-radius: 4px; 395 | border-bottom-left-radius: 4px; 396 | } 397 | .pagination-item:last-child { 398 | margin-left: -1px; 399 | border-top-right-radius: 4px; 400 | border-bottom-right-radius: 4px; 401 | } 402 | } 403 | -------------------------------------------------------------------------------- /public/css/rjow.css: -------------------------------------------------------------------------------- 1 | body { 2 | color: #fff; 3 | background-color: #333; 4 | -webkit-text-size-adjust: 100%; 5 | -ms-text-size-adjust: 100%; 6 | } 7 | 8 | /* Headings */ 9 | h1, h2, h3, h4, h5, h6 { 10 | color: #dfdfdf; 11 | } 12 | 13 | /* Quotes */ 14 | blockquote { 15 | color: #9a9a9a; 16 | } 17 | 18 | pre, code, pre code { 19 | background-color: #555; 20 | color: #fc0; 21 | } 22 | 23 | strong { 24 | color: #f90; 25 | } 26 | 27 | tbody tr:nth-child(odd) td, 28 | tbody tr:nth-child(odd) th { 29 | background-color: #555; 30 | } 31 | 32 | 33 | @media (min-width: 48rem) { 34 | .content { 35 | max-width: 40rem; 36 | } 37 | } 38 | 39 | .content { 40 | padding-top: 2rem; 41 | padding-bottom: 4rem; 42 | } 43 | 44 | /* Blog post or page title */ 45 | .page-title, 46 | .post-title, 47 | .post-title a { 48 | color: #fc0; 49 | margin-top: 2rem; 50 | } 51 | 52 | /* Jekyll yellow */ 53 | .theme-jekyll .sidebar { 54 | background-color: #fc0; 55 | color: rgba(0,0,0,.7); 56 | } 57 | .theme-jekyll .content a, 58 | .theme-jekyll .related-posts li a:hover { 59 | color: #fc0; 60 | } 61 | .theme-jekyll .content a:hover { 62 | color: #f90; 63 | } 64 | 65 | .sidebar { 66 | padding: 1rem; 67 | text-align: center; 68 | } 69 | 70 | /* Sidebar links */ 71 | .sidebar a { 72 | color: #333; 73 | } 74 | 75 | /* About section */ 76 | .sidebar-about h1 { 77 | color: #333; 78 | font-size: 2.5rem; 79 | } 80 | 81 | .post-date { 82 | color: #ddd; 83 | } 84 | 85 | .button-monster { 86 | display: block; 87 | padding: 1rem; 88 | margin: 2rem 0; 89 | border: 1px solid #eee; 90 | border-radius: 4px; 91 | font-family: "PT Sans", Helvetica, Arial, sans-serif; 92 | text-align: center; 93 | } 94 | .theme-jekyll .content a.button-monster:hover { 95 | background-color: #fc0; 96 | color: #333; 97 | } 98 | 99 | .button-external { 100 | display: block; 101 | padding: 0.5rem; 102 | margin: 1rem 0; 103 | border: 1px solid #eee; 104 | border-radius: 3px; 105 | font-family: "PT Sans", Helvetica, Arial, sans-serif; 106 | text-align: center; 107 | } 108 | .theme-jekyll .content a.button-external:hover { 109 | background-color: #fc0; 110 | color: #333; 111 | } 112 | 113 | .theme-jekyll .content a.pagination-item:hover { 114 | background-color: #fc0; 115 | color: #333; 116 | } 117 | 118 | .step { 119 | display: block; 120 | width: 3rem; 121 | height: 3rem; 122 | float: right; 123 | background-color: #fc0; 124 | color: #333; 125 | text-align: center; 126 | border-radius: 50%; 127 | font-size: 2rem; 128 | font-weight: bold; 129 | } 130 | 131 | .img-nice { 132 | display: block; 133 | width: 100%; 134 | height: auto; 135 | } 136 | 137 | .footer { 138 | margin-top: 5rem; 139 | color: #aaa; 140 | } 141 | -------------------------------------------------------------------------------- /public/css/syntax.css: -------------------------------------------------------------------------------- 1 | .hll { background-color: #ffffcc } 2 | /*{ background: #f0f3f3; }*/ 3 | .c { color: #999; } /* Comment */ 4 | .err { color: #AA0000; background-color: #FFAAAA } /* Error */ 5 | .k { color: #006699; } /* Keyword */ 6 | .o { color: #555555 } /* Operator */ 7 | .cm { color: #0099FF; font-style: italic } /* Comment.Multiline */ 8 | .cp { color: #009999 } /* Comment.Preproc */ 9 | .c1 { color: #999; } /* Comment.Single */ 10 | .cs { color: #999; } /* Comment.Special */ 11 | .gd { background-color: #FFCCCC; border: 1px solid #CC0000 } /* Generic.Deleted */ 12 | .ge { font-style: italic } /* Generic.Emph */ 13 | .gr { color: #FF0000 } /* Generic.Error */ 14 | .gh { color: #003300; } /* Generic.Heading */ 15 | .gi { background-color: #CCFFCC; border: 1px solid #00CC00 } /* Generic.Inserted */ 16 | .go { color: #AAAAAA } /* Generic.Output */ 17 | .gp { color: #000099; } /* Generic.Prompt */ 18 | .gs { } /* Generic.Strong */ 19 | .gu { color: #003300; } /* Generic.Subheading */ 20 | .gt { color: #99CC66 } /* Generic.Traceback */ 21 | .kc { color: #006699; } /* Keyword.Constant */ 22 | .kd { color: #006699; } /* Keyword.Declaration */ 23 | .kn { color: #006699; } /* Keyword.Namespace */ 24 | .kp { color: #006699 } /* Keyword.Pseudo */ 25 | .kr { color: #006699; } /* Keyword.Reserved */ 26 | .kt { color: #007788; } /* Keyword.Type */ 27 | .m { color: #FF6600 } /* Literal.Number */ 28 | .s { color: #d44950 } /* Literal.String */ 29 | .na { color: #4f9fcf } /* Name.Attribute */ 30 | .nb { color: #336666 } /* Name.Builtin */ 31 | .nc { color: #00AA88; } /* Name.Class */ 32 | .no { color: #336600 } /* Name.Constant */ 33 | .nd { color: #9999FF } /* Name.Decorator */ 34 | .ni { color: #999999; } /* Name.Entity */ 35 | .ne { color: #CC0000; } /* Name.Exception */ 36 | .nf { color: #CC00FF } /* Name.Function */ 37 | .nl { color: #9999FF } /* Name.Label */ 38 | .nn { color: #00CCFF; } /* Name.Namespace */ 39 | .nt { color: #2f6f9f; } /* Name.Tag */ 40 | .nv { color: #003333 } /* Name.Variable */ 41 | .ow { color: #000000; } /* Operator.Word */ 42 | .w { color: #bbbbbb } /* Text.Whitespace */ 43 | .mf { color: #FF6600 } /* Literal.Number.Float */ 44 | .mh { color: #FF6600 } /* Literal.Number.Hex */ 45 | .mi { color: #FF6600 } /* Literal.Number.Integer */ 46 | .mo { color: #FF6600 } /* Literal.Number.Oct */ 47 | .sb { color: #CC3300 } /* Literal.String.Backtick */ 48 | .sc { color: #CC3300 } /* Literal.String.Char */ 49 | .sd { color: #CC3300; font-style: italic } /* Literal.String.Doc */ 50 | .s2 { color: #CC3300 } /* Literal.String.Double */ 51 | .se { color: #CC3300; } /* Literal.String.Escape */ 52 | .sh { color: #CC3300 } /* Literal.String.Heredoc */ 53 | .si { color: #AA0000 } /* Literal.String.Interpol */ 54 | .sx { color: #CC3300 } /* Literal.String.Other */ 55 | .sr { color: #33AAAA } /* Literal.String.Regex */ 56 | .s1 { color: #CC3300 } /* Literal.String.Single */ 57 | .ss { color: #FFCC33 } /* Literal.String.Symbol */ 58 | .bp { color: #336666 } /* Name.Builtin.Pseudo */ 59 | .vc { color: #003333 } /* Name.Variable.Class */ 60 | .vg { color: #003333 } /* Name.Variable.Global */ 61 | .vi { color: #003333 } /* Name.Variable.Instance */ 62 | .il { color: #FF6600 } /* Literal.Number.Integer.Long */ 63 | 64 | .css .o, 65 | .css .o + .nt, 66 | .css .nt + .nt { color: #999; } 67 | -------------------------------------------------------------------------------- /public/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/juthilo/run-jekyll-on-windows/4cbb3297eaa74376ca6cb8cd71f706ab8f9fb86c/public/favicon.ico -------------------------------------------------------------------------------- /public/img/python-path.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/juthilo/run-jekyll-on-windows/4cbb3297eaa74376ca6cb8cd71f706ab8f9fb86c/public/img/python-path.png -------------------------------------------------------------------------------- /public/img/ruby-path.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/juthilo/run-jekyll-on-windows/4cbb3297eaa74376ca6cb8cd71f706ab8f9fb86c/public/img/ruby-path.png --------------------------------------------------------------------------------