Statistics
| Branch: | Revision:

iof-website / README.md @ master

History | View | Annotate | Download (2.63 KB)

1 4a7c8df9 Michele Segata
# Architect theme
2
3
This is a [Jekyll][1] theme that is an adaptation of [@jasonlong][2]'s [Architect theme][4] on [GitHub Pages][3].
4
5
This is the raw HTML and styles that are used for the *Architect* theme on [GitHub Pages](https://pages.github.com/).
6
7
![](https://cl.ly/image/1x0Q3213330G/content)
8
9
# Getting Started
10
11
## Prerequisites
12
13
To install this theme, jekyll is required to be installed on your system. Head over to the [docs](https://jekyllrb.com/docs/installation/) and install the four requirements (Ruby, RubyGems, Node.js and Python 2.7). If you're on a Mac system, it's likely the only package you'll need to install is Node.js
14
15
Once you've installed the requirements, run this command in your terminal:
16
17
```
18
$ sudo gem install jekyll
19
```
20
21
You'll also need to install the bundler package:
22
23
```
24
$ sudo gem install bundler
25
```
26
27
## Downloading and Installing the theme
28
29
Download the theme
30
31
```
32
https://github.com/pietromenna/jekyll-architect-theme/archive/master.zip
33
```
34
35
Unzip it and use it as a regular jekyll folder.
36
37
```
38
$ unzip jekyll-architect-theme-master.zip
39
```
40
41
Get inside the newly extracted folder
42
43
```
44
$ cd jekyll-architect-theme-master
45
```
46
47
Install the dependencies
48
49
```
50
$ bundle install
51
```
52
53
Use it!
54
55
```
56
$ jekyll serve
57
```
58
59
# Setup
60
61
Some important configuration can be done in the file `_config.yml`. Please, check the Setup section in that file.
62
63
64
## baseurl
65
66
`baseurl` parameter is required in the case the site doesn't sit on the root of the domain. For example: https://pietromenna.github.io/jekyll-architect-theme
67
68
In the case above the baseurl should be set to "/jekyll-architect-theme".
69
70
In the case the site sits in the root, you can leave `baseurl` as empty "".
71
72
73
For more details read about [Jekyll][1] on its web page.
74
75
# Contributing
76
77
Bug reports and pull requests are welcome on GitHub at https://github.com/pietromenna/jekyll-architect-theme.
78
79
# Development
80
81
To set up your environment to develop this theme, run `bundle install`.
82
83
You theme is setup just like a normal Jelyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
84
85
# License
86
87
This work is licensed under a [Creative Commons Attribution 4.0 International](http://creativecommons.org/licenses/by/4.0/).
88
89
[1]: https://jekyllrb.com
90
[2]: https://github.com/jasonlong
91
[3]: http://pages.github.com/
92
[4]: https://github.com/jasonlong/architect-theme