├── .editorconfig
├── .jshintrc
├── LICENSE
├── README.md
├── _footer.html
├── _header.html
├── bower.json
├── package.json
├── scripts
├── hgt.js
└── vendor
│ ├── infinite.min.js
│ ├── jquery.waypoints.min.js
│ └── sticky.min.js
└── styles
├── hgt-syntax.css
└── hgt.css
/.editorconfig:
--------------------------------------------------------------------------------
1 | # EditorConfig helps developers define and maintain consistent
2 | # coding styles between different editors and IDEs
3 | # editorconfig.org
4 |
5 | root = true
6 |
7 |
8 | [*]
9 |
10 | # Change these settings to your own preference
11 | indent_style = space
12 | indent_size = 2
13 |
14 | # We recommend you to keep these unchanged
15 | end_of_line = lf
16 | charset = utf-8
17 | trim_trailing_whitespace = true
18 | insert_final_newline = true
19 |
20 | [*.md]
21 | trim_trailing_whitespace = false
22 |
--------------------------------------------------------------------------------
/.jshintrc:
--------------------------------------------------------------------------------
1 | {
2 | "node": true,
3 | "browser": true,
4 | "esnext": true,
5 | "bitwise": true,
6 | "camelcase": true,
7 | "curly": true,
8 | "eqeqeq": true,
9 | "immed": true,
10 | "indent": 2,
11 | "latedef": true,
12 | "newcap": true,
13 | "noarg": true,
14 | "quotmark": "single",
15 | "regexp": true,
16 | "undef": true,
17 | "unused": true,
18 | "strict": true,
19 | "trailing": true,
20 | "smarttabs": true,
21 | "globals": {
22 | "$": false
23 | }
24 | }
25 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | The MIT License (MIT)
2 |
3 | Copyright (c) 2015 Puzzle ITC GmbH
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in
13 | all copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21 | THE SOFTWARE.
22 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Hologram Github Theme
2 |
3 | This is a very simple [Github Styleguide](https://github.com/styleguide) inspired theme for Trulia's [Hologram](https://github.com/trulia/hologram), the ruby front-end doc generator.
4 |
5 | ## Preview
6 |
7 |
8 |
9 | [View example styleguide](http://wearecube.github.io/hologram-github-theme-example/styleguide) ([source code](https://github.com/wearecube/hologram-github-theme-example))
10 |
11 | ## Usage
12 |
13 | Install Hologram:
14 |
15 | ```
16 | $ gem install hologram
17 | ```
18 |
19 | Add this theme to your project using NPM:
20 |
21 | ```
22 | $ npm install --save-dev hologram-github-theme
23 | ```
24 |
25 | Alternatively you may use Bower:
26 |
27 | ```
28 | $ bower install --save-dev hologram-github-theme
29 | ```
30 |
31 | Define the theme in your `hologram_config.yml`:
32 |
33 | ```
34 | # Relative path(s) to your source files
35 | source: app/styles
36 |
37 | # Relative path where you want the documentation to be built
38 | destination: styleguide
39 |
40 | # The path that contains supporting assets for the documentation page
41 | documentation_assets: node_modules/hologram-github-theme
42 |
43 | # Category that will be used as the index.html (optional)
44 | index: styleguide
45 |
46 | # A list of relative paths to folders containing any dependencies to copy
47 | dependencies:
48 | - 'dist'
49 |
50 | # The CSS files to be included in the styleguide
51 | css_include:
52 | - 'dist/styles/vendor.css'
53 | - 'dist/styles/main.css'
54 |
55 | # The JavaScript files to included in the styleguide
56 | js_include:
57 | - 'dist/scripts/main.js'
58 |
59 | # The global title that is displayed at the top of the pages
60 | global_title: Styleguide
61 |
62 | ```
63 |
64 | In this example the markdown file `app/styles/styleguide.md` is used for the content on the index page. Also, if you're using Bower, adjust the package path accordingly: ```documentation_assets: bower_components/hologram-github-theme```.
65 |
66 | For more details on the options, checkout the [Hologram documentation](https://github.com/trulia/hologram/blob/master/README.md#creating-a-yaml-config-file)
67 |
68 | Finally, build the styleguide:
69 |
70 | ```
71 | hologram -c hologram_config.yml
72 | ```
73 |
74 | ## Authors
75 |
76 | The Hologram Github Theme has been created by [Mathis Hofer](https://github.com/hupf). Many thanks to [Maurice Kühlborn](https://github.com/minimalweb) and [Oscar](https://github.com/obartra) for their contributions.
77 |
78 | ## License
79 |
80 | The Hologram Github Theme is licensed under the [MIT License](LICENSE)
81 |
--------------------------------------------------------------------------------
/_footer.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 | <% if @config['js_include'].to_s.strip.length != 0 %>
17 | <% @config['js_include'].each do |js| %>
18 |
19 | <% end %>
20 | <% end %>
21 |
22 | <% if @config['components_include'].to_s.strip.length != 0 %>
23 | <% @config['components_include'].each do |component| %>
24 |
25 | <% end %>
26 | <% end %>
27 |