|
1 | | -# Solo ([Live Demo](http://solo.chibi.io)) |
| 1 | +# Solo |
2 | 2 |
|
3 | 3 | [Solo](http://solo.chibi.io) is a Jekyll theme that supports **single-page websites** only, but supports them well. Yes, it's responsive. |
4 | 4 |
|
5 | | -<iframe src="http://ghbtns.com/github-btn.html?user=chibicode&repo=solo&type=watch&count=true&size=large" |
6 | | - allowtransparency="true" frameborder="0" scrolling="0" width="170" height="30"></iframe><br/> |
7 | | - |
8 | | -Looking for a more standard Jekyll theme? Try out [Shiori](http://github.com/ellekasai/shiori) theme, which has Bootstrap integration. |
9 | | - |
10 | | -## Solo is useful if... |
11 | | - |
12 | | -* You want to create an "about me" page from a single markdown file and host it under a custom domain name. |
13 | | -* You want to create a single-page website that's mostly text, like [Know Your Company](https://knowyourcompany.com/). |
14 | | -* You want to share a single markdown file and tried GitHub Gist ([example](https://gist.github.com/dypsilon/5819504)), but would like something nicer-looking. |
15 | | -* You want something like GitHub's [automatic page generator](http://pages.github.com/) for a non-code repository. |
16 | | - |
17 | | -This page itself is built with Solo. It's generated from [this markdown file](https://github.com/chibicode/solo/blob/gh-pages/_includes/index.md). |
18 | | - |
19 | | -## Usage |
20 | | - |
21 | | -First, [install Jekyll](http://jekyllrb.com/docs/installation/). Then download Solo from its [GitHub Repository](https://github.com/chibicode/solo). Start Jekyll and you should see this page up and running. |
22 | | - |
23 | | -**The main file you'll be editing is `index.md`**. This becomes the content for the main `index.html`. |
24 | | - |
25 | | -### Other Files |
26 | | - |
27 | | -* Edit `_config.yml` to change the site's title and description. |
28 | | -* Edit `_includes/head.html` to add custom code to `<head>`. |
29 | | -* Edit `_includes/scripts.html` to add custom code before `</body>`. |
30 | | -* Edit `README.md` before pushing your code. |
31 | | -* Optional: Add `CNAME` to host on a custom domain. |
32 | | - |
33 | | -### Don't use `<h1>` tags |
34 | | - |
35 | | -Wthin `index.md`, do not use `<h1>` tags - `<h1>` is reserved for the site title. |
36 | | - |
37 | | -### Supported Tags |
38 | | - |
39 | | -Solo supports lists, `<hr>`s, `<table>`s, |
40 | | - |
41 | | -> blockquotes, and... |
42 | | -
|
43 | | -~~~html |
44 | | -<pre>code blocks with syntax highlighting.</pre> |
45 | | -~~~ |
46 | | - |
47 | | -### Keep Solo up to date |
48 | | - |
49 | | -Instead of downloading, you can [fork Solo](https://github.com/chibicode/solo/fork) and use the "upstream" strategy described on [this page](https://help.github.com/articles/fork-a-repo) to keep Solo up to date. |
50 | | - |
51 | | -## Author |
52 | | - |
53 | | -Shu Uesugi ([Twitter](http://twitter.com/chibicode)/[GitHub](http://github.com/chibicode)/[G+](https://plus.google.com/110325199858284431541?rel=author)). |
54 | | - |
55 | | - |
56 | | - |
57 | | -### License |
58 | | - |
59 | | -[MIT License](http://chibicode.mit-license.org/) |
60 | | - |
61 | | -<div class="github-fork-ribbon-wrapper right fixed" style="width: 150px;height: 150px;position: fixed;overflow: hidden;top: 0;z-index: 9999;pointer-events: none;right: 0;"><div class="github-fork-ribbon" style="position: absolute;padding: 2px 0;background-color: #333;background-image: linear-gradient(to bottom, rgba(0, 0, 0, 0), rgba(0, 0, 0, 0.15));-webkit-box-shadow: 0 2px 3px 0 rgba(0, 0, 0, 0.5);-moz-box-shadow: 0 2px 3px 0 rgba(0, 0, 0, 0.5);box-shadow: 0 2px 3px 0 rgba(0, 0, 0, 0.5);z-index: 9999;pointer-events: auto;top: 42px;right: -43px;-webkit-transform: rotate(45deg);-moz-transform: rotate(45deg);-ms-transform: rotate(45deg);-o-transform: rotate(45deg);transform: rotate(45deg);"><a href="https://github.com/chibicode/solo" style="font: 700 13px "Helvetica Neue", Helvetica, Arial, sans-serif;color: #fff;text-decoration: none;text-shadow: 0 -1px rgba(0, 0, 0, 0.5);text-align: center;width: 200px;line-height: 20px;display: inline-block;padding: 2px 0;border-width: 1px 0;border-style: dotted;border-color: rgba(255, 255, 255, 0.7);">Fork me on GitHub</a></div></div> |
| 5 | +### [Demo & Documentation →](http://solo.chibi.io) |
0 commit comments