-
Notifications
You must be signed in to change notification settings - Fork 2
/
Config
159 lines (118 loc) · 4.12 KB
/
Config
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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
# GitStrap page configuration file.
This configuration file `Config` is used to setup this demo site. It is written
in Markdown and is parsed for options starting with the '`>`' character and
wrapped in a code block '<code>```</code>' for actual configuration options
([see the actual file for how this
looks](https://github.com/nckz/GitStrap/blob/gh-pages/Config)).
## 1. Site Title
This title will show up on the left side of the navigation bar and on the
browser tab.
Example: >My Favorite Website
This setup uses the following:
```
>GitStrap
```
<a name="pagesandnav"></a>
## 2. Pages / Navigation
List your pages below in the order in which you'd like them to show up on your
website's navigation bar. Make sure each item is separated by a space. These
pages must reflect an actual filename in the root/base directory, you can start
by editing these files or adding new ones -remember the filename is the same as
what shows up on the navigation tab.
Example: >Home Contacts About
Use the keyword 'GSBLOG' to place the link for a blog index.
Example: >Home Contacts GSBLOG About
This setup uses the following:
```
>Readme.md Config Header Footer Example GSBLOG
```
## 3. Theme
Put the theme name or url from [bootswatch](https://www.bootstrapcdn.com/bootswatch/).
Examples: >cerulean, >cosmo, >cyborg, >darkly, >flatly, >journal, >lumen,
>paper, >readable, >sandstone, >simplex, >slate, >spacelab, >superhero,
>united, and >yeti.
This setup uses the following:
```
>journal
```
## 4. Header
A running header text can be specified in a file, if desired. To turn off the
header text set this option to false.
Example: >false
This setup uses the following:
```
>Header
```
## 5. Footer
A running footer for each page.
Example: >false
This setup uses the following:
```
>Footer
```
## 6. Blog
If a blog is desired, the post files (stored in `/posts/` directory) will be
included in the same way as navigation items. Include the desired blog entires
by adding them to the list. If a blog is desired, make sure to set the
`GSBLOG` keyword in the Nav item list above. The blog index link is named by
the first element in the post list:
Example: >Index post1 post2 post3 post4
Where "Index" would be the blog index link name. This setup uses the following
(where "Blog" is the link to the blog index and each blog file is listed on a
new line or separated with a space as shown above):
```
>Blog
Using-The-Blog
GitStrap-Dependencies
The-Index-File
Using-GitStrap-With-GitLab
```
## 7. Code
GitStrap uses the google-prettify project for code syntax highlighting. You can
choose themes from
[google](https://github.com/google/code-prettify/tree/9c3730f40994018a8ca9b786b088826b60d7b54a/styles)
or
[jmblog](https://github.com/jmblog/color-themes-for-google-code-prettify/tree/be5aa6fee61ad73f5a34ffb65099c8d1b3917602/dist/themes)
. Some examples of valid themes are:
Examples: >desert, >doxy, >sons-of-obsidian, >sunburst, >tomorrow,
>tomorrow-night, >tomorrow-night-blue, >tomorrow-night-bright,
>tomorrow-night-eighties, >atelier-cave-dark,
>atelier-sulphurpool-dark, >atelier-cave-light, >github, and
>github-v2.
You can also use a url that points to a specific css file. This setup uses
the following:
```
>tomorrow
```
## 8. Google Analytics
To allow [Google Analytics](https://analytics.google.com/) tracking set your
Google Analytics [tracking
ID](https://support.google.com/analytics/answer/1032385?hl=en) here, or set to
`false` if its not used:
Example: >UA-000000-01
or
Example: >false
This site uses:
```
>UA-76185171-2
```
## 9. Disqus Blog Comments
To add [Disqus](https://disqus.com) comments to the blog section, set your
site's [disqus
shortname](https://help.disqus.com/customer/portal/articles/466208) here, or
set to `false` if its not used:
Example: >myblogname
or
Example: >false
This site uses:
```
>gitstrap
```
## 10. Pagination
The number of blog posts that fit on a single page can be set here. A zero
value will turn off pagination and all posts will go on a single page.
Example: >0
This site uses:
```
>3
```