|
| 1 | +# Solo |
| 2 | + |
| 3 | +Solo is a Jekyll theme that only supports **single-page websites**, but supports them well. If you want to create a single-page website that's mostly text, like <a href="https://knowyourcompany.com/" target="_blank">Know Your Company</a>, Solo would be a good choice. |
| 4 | + |
| 5 | +<a href="https://github.com/chibicode/solo"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub"></a> |
| 6 | + |
| 7 | +<iframe src="http://ghbtns.com/github-btn.html?user=chibicode&repo=solo&type=watch&count=true&size=large" |
| 8 | + allowtransparency="true" frameborder="0" scrolling="0" width="170" height="30"></iframe><br/> |
| 9 | + |
| 10 | +## Example |
| 11 | + |
| 12 | +This page is built using Solo, as well as my <a href="https://chibicode.com/" target="_blank">personal website</a>. Solo supports lists, `<hr>`'s, tables, |
| 13 | + |
| 14 | +> blockquotes, and... |
| 15 | +
|
| 16 | +~~~html |
| 17 | +<pre>code blocks with syntax highlighting.</pre> |
| 18 | +~~~ |
| 19 | + |
| 20 | +## Usage |
| 21 | + |
| 22 | +First, [install Jekyll](http://jekyllrb.com/docs/installation/). Then download Solo from its [GitHub Repository](https://github.com/poole/poole). Start Jekyll and you should see this page up and running. |
| 23 | + |
| 24 | +**The main file you'll be editing is `_includes/index.md`**. This becomes the content for the main `index.html`. |
| 25 | + |
| 26 | +### Other Files |
| 27 | + |
| 28 | +* Edit `_includes/title` to change the site title. |
| 29 | +* Edit `_includes/head.html` to add custom code to `<head>`. |
| 30 | +* Edit `_includes/scripts.html` to add custom code before `</body>`. |
| 31 | +* Edit `CNAME` to host on a custom domain. |
| 32 | + |
| 33 | +### Don't use `<h1>` tags |
| 34 | + |
| 35 | +Wthin `solo.md`, do not use `<h1>` tags - `<h1>` is reserved for the site title. |
| 36 | + |
| 37 | +### Keep Solo up to date |
| 38 | + |
| 39 | +Instead of downloading, you can [fork Solo](https://github.com/chibicode/solo/fork) and [use "upstream" strategy described on this page](https://help.github.com/articles/fork-a-repo) to keep Solo up to date. |
| 40 | + |
| 41 | +## Author |
| 42 | + |
| 43 | +Shu Uesugi ([Twitter](http://twitter.com/chibicode)/[GitHub](http://github.com/chibicode)). |
| 44 | + |
| 45 | + |
| 46 | + |
| 47 | +### License |
| 48 | + |
| 49 | +Copyright (c) 2014 Shusaku Uesugi |
| 50 | + |
| 51 | +Permission is hereby granted, free of charge, to any person obtaining a copy |
| 52 | +of this software and associated documentation files (the "Software"), to deal |
| 53 | +in the Software without restriction, including without limitation the rights |
| 54 | +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| 55 | +copies of the Software, and to permit persons to whom the Software is |
| 56 | +furnished to do so, subject to the following conditions: |
| 57 | + |
| 58 | +The above copyright notice and this permission notice shall be included in |
| 59 | +all copies or substantial portions of the Software. |
| 60 | + |
| 61 | +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 62 | +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 63 | +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 64 | +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 65 | +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 66 | +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
| 67 | +THE SOFTWARE. |
0 commit comments