blob: ede9908728636980ff22362de29cdf6b0190a2f1 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
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
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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
|
GridSide Theme
==============
The GridSide theme is a multi-page portfolio and blog utilizing the
[Materialize][materialize] frontend framework. Medium-style comments may be
added to blog entries using [SideComments.js][sidecomments.js].
The theme contains a main page with a single grid of images representing
different sections of the website. Sections can be marked as blog, project,
contact, or miscellaneous in order to provide slight changes in styling.
- Current Materialize version is `0.97.0`.
- Current Font Awesome version is `4.4.0`.
- Current SideComments.js version is `0.0.3`.
- Current Masonry.js version is `3.3.1`.
- Current imagesLoaded.js version is `3.1.8`.
- Current Modernizr.js version is `2.8.3`.
- Current Highlight.js version is `8.7` and contains all 130 languages.
- Current lazysizes.js version is `1.2.0`.
- Current ls.noscript.js version is `1.2.0`.
- Current lightbox.js version is `2.8.1`.
- Current infinitescroll.js version is `2.1.0`.
Contents
--------
- [Installation](#installation)
- [Getting Started](#getting-started)
- [The Config File](#the-config-file)
- [Adding a Blog Section](#adding-a-blog-section)
- [Optional - Adding Medium-style Comments with Hull.io](#optional---adding-medium-style-comments-with-hullio)
- [Adding a Project Section](#adding-a-project-section)
- [Adding a Contact Section](#adding-a-contact-section)
- [Adding a Miscellaneous Section](#adding-a-miscellaneous-section)
- [Nearly Finished](#nearly-finished)
- [TODO](#todo)
- [Notes](#notes)
- [Contributing](#contributing)
- [License](#license)
Installation
------------
Inside the folder of your Hugo site run:
$ mkdir themes
$ cd themes
$ git clone https://github.com/rcsenkbeil/grid-side
For more information read the official [setup guide][setup_guide] of Hugo.
Getting Started
---------------
### The Config File ###
Take a look inside the [`exampleSite`][exampleSite] folder of this theme.
You'll find a file called [`config.toml`][config.toml]. To use it, copy the
[`config.toml`][config.toml] in the root folder of your Hugo site. Feel free
to customize this theme as you like.
### Adding a Blog Section ###
TODO
#### Optional - Adding Medium-style Comments with Hull.io ####
TODO
### Adding a Project Section ###
TODO
### Adding a Contact Section ###
TODO
### Adding a Miscellaneous Section ###
TODO
### Nearly Finished ###
In order to see your site in action, run Hugo's built-in local server.
$ hugo server -w
Now enter `localhost:1313` in the address bar of your browser.
TODO
----
See [TODO][todo] for more information.
Notes
-----
Currently there are two features that require Javascript: parallax scrolling
and centering text within the grid.
Parallax is provided by the Materialize library.
Centering text is a hack that will hopefully be removed in the future, but
is needed to center text within a floating element. The culprit is the
Materialize column adding a `float: left`, causing flexbox alignments to
be ignored. See [here][centering_problem] for more information.
Potential grid replacement would be [Flexbox Grid][flexbox_grid], which
should allow proper vertical centering.
Contributing
------------
Report any bugs using the [issue tracker][issue_tracker]. Submit your own bug
fixes or feature additions via a [pull request][pull_request].
License
-------
This theme is released under the MIT License. For more information read the
[license][license].
[materialize]: http://www.materializecss.com/
[sidecomments.js]: https://github.com/aroc/side-comments
[setup_guide]: http://gohugo.io/overview/installing/
[exampleSite]: https://github.com/rcsenkbeil/grid-side/tree/master/exampleSite
[config.toml]: https://github.com/rcsenkbeil/grid-side/blob/master/exampleSite/config.toml
[issue_tracker]: https://github.com/rcsenkbeil/grid-side/issues
[pull_request]: https://github.com/rcsenkbeil/grid-side/pulls
[license]: https://github.com/rcsenkbeil/grid-side/blob/master/LICENSE
[centering_problem]: https://github.com/Dogfalo/materialize/issues/1241
[flexbox_grid]: http://flexboxgrid.com
[todo]: https://github.com/rcsenkbeil/grid-side/blob/master/TODO
|
