You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Sep 25, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+19-8Lines changed: 19 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -72,16 +72,27 @@ searchgov:
72
72
73
73
74
74
## How to edit
75
-
- We try to keep configuration options to a minimum so you can easily remove functionality, but you can review `_config.yml` to see the options that are available to you. There are a few values on top that you **need** to change. They make reference to the agency name and contact information. The advanced options at the bottom should be changed only if you know what you know what you're doing.
76
-
- Do not edit files in the `assets/` folder. This folder is reserved for serving assets once the sites is compiled. If you want add your own custom code, add and edit files in `src/`, ideally mirroring the `assets/` folder structure. This will keep the code repository small and not include unneccessary files.
77
-
- If you look at `package.json` you will see that the `npm run federalist` command will copy the contents from `src/` and move it over to `assets/` folder during the build process. If you want more advanced functionality, you should look into using [Webpack](https://webpack.js.org/concepts/configuration/).
78
-
- Do not edit files in the `_site/` folder. These files are automatically generated and changes you make there will be destroyed.
79
-
- You will most certainly need to edit files in `_includes/`, which include the primary menu, side navigation, logos etc
75
+
- Non-developers should focus on editing markdown content in the `_posts` and `_pages` folder
76
+
77
+
- We try to keep configuration options to a minimum so you can easily change functionality. You should review `_config.yml` to see the options that are available to you. There are a few values on top that you **need** to change. They refer to the agency name and contact information. The rest of `_config.yml` has a range of more advanced options.
78
+
79
+
- The contents inside `assets/` folder store your Javascript, SCSS/CSS, images, and other media assets are managed by [jekyll-assets](https://github.com/envygeeks/jekyll-assets). Assets are combined, compressed, and automatically available in your theme
80
+
81
+
- If you look at `package.json` you will see that the `npm run federalist` command that will run when running on the Federalist platform.
82
+
83
+
- Do not edit files in the `_site/` folder. These files are auto-generated, and any change you make in the folder will be overwritten.
84
+
85
+
- To edit the look and feel of the site, you need to edit files in `_includes/` folder, which render key components, like the menu, side navigation, and logos.
86
+
80
87
-`index.html` may not require much editing, depending on how you customize `hero.html` and `highlights.html`.
88
+
81
89
-`_layouts/` may require the least amount of editing of all the files since they are primarily responsible for printing the content.
82
-
-`blog/search.html` is by search.gov. If you need to stylize results page, this is where you will do it.
83
-
-`blog/index.html` can be edited, but be careful. It will impact the pagination system for the posts. If you do edit the file, be prepared to edit `_config.yml`. You should also familiarize yourself with [jekyll-paginate-v2](https://github.com/sverrirs/jekyll-paginate-v2)
84
-
- Non-developers should focus only on `_posts` and `_pages`
90
+
91
+
-`blog/index.html` can be edited, but be careful. It will impact the pagination system for the posts. If you do edit the file, be prepared to edit `_config.yml`. For example, you may need go change configurations for [jekyll-paginate-v2](https://github.com/sverrirs/jekyll-paginate-v2)
# Site configuration for the Jekyll 3 Pagination Gem
98
96
# The values here represent the defaults if nothing is set
99
97
pagination:
100
-
101
98
# Site-wide kill switch, disabled here it doesn't run at all
102
99
enabled: true
103
-
104
100
# Set to 'true' to enable pagination debugging. This can be enabled in the site config or only for individual pagination pages
105
101
debug: false
106
-
107
102
# The default document collection to paginate if nothing is specified ('posts' is default)
108
-
collection: 'posts'
109
-
103
+
collection: "posts"
110
104
# How many objects per paginated page, used to be `paginate` (default: 0, means all)
111
105
per_page: 3
112
-
113
106
# The permalink structure for the paginated pages (this can be any level deep)
114
-
permalink: '/page/:num/'# Pages are index.html inside this folder (default)
107
+
permalink: "/page/:num/"# Pages are index.html inside this folder (default)
115
108
#permalink: '/page/:num.html' # Pages are simple html files
116
109
#permalink: '/page/:num' # Pages are html files, linked jekyll extensionless permalink style.
117
-
118
110
# Optional the title format for the paginated pages (supports :title for original page title, :num for pagination page number, :max for total number of pages)
119
-
title: ':title - page :num'
120
-
111
+
title: ":title - page :num"
121
112
# Limit how many pagenated pages to create (default: 0, means all)
122
113
limit: 0
123
-
124
114
# Optional, defines the field that the posts should be sorted on (omit to default to 'date')
125
-
sort_field: 'date'
126
-
115
+
sort_field: "date"
127
116
# Optional, sorts the posts in reverse order (omit to default decending or sort_reverse: true)
128
117
sort_reverse: true
129
-
130
118
# Optional, the default category to use, omit or just leave this as 'posts' to get a backwards-compatible behavior (all posts)
131
-
category: 'posts'
132
-
119
+
category: "posts"
133
120
# Optional, the default tag to use, omit to disable
134
-
tag: ''
135
-
121
+
tag: ""
136
122
# Optional, the default locale to use, omit to disable (depends on a field 'locale' to be specified in the posts,
137
123
# in reality this can be any value, suggested are the Microsoft locale-codes (e.g. en_US, en_GB) or simply the ISO-639 language code )
138
-
locale: ''
139
-
140
-
# Optional,omit or set both before and after to zero to disable.
141
-
# Controls how the pagination trail for the paginated pages look like.
124
+
locale: ""
125
+
# Optional,omit or set both before and after to zero to disable.
126
+
# Controls how the pagination trail for the paginated pages look like.
142
127
trail:
143
128
before: 2
144
129
after: 2
145
-
146
130
# Optional, the default file extension for generated pages (e.g html, json, xml).
147
131
# Internally this is set to html by default
148
132
extension: html
149
-
150
133
# Optional, the default name of the index file for generated pages (e.g. 'index.html')
151
134
# Without file extension
152
-
indexpage: 'index.html'
153
-
154
-
155
-
156
-
# # Configuration for jekyll_pages_api_search plugin gem.
157
-
# jekyll_pages_api_search:
158
-
# # Uncomment this to speed up site generation while developing.
159
-
# #skip_index: true
160
-
#
161
-
# # Each member of `index_fields` should correspond to a field generated by
162
-
# # the jekyll_pages_api. It can hold an optional `boost` member as a signal
163
-
# # to Lunr.js to weight the field more highly (default is 1).
164
-
# index_fields:
165
-
# title:
166
-
# boost: 10
167
-
# tags:
168
-
# boost: 10
169
-
# url:
170
-
# boost: 5
171
-
# body:
172
-
#
173
-
# # If defined and browserify and uglifyify are installed, the plugin will
174
-
# # generate a bundle to define the renderJekyllPagesApiSearchResults
175
-
# # function.
176
-
# browserify:
177
-
# source: js/my-search.js
178
-
# target: js/my-search-bundle.js
179
-
#
180
-
135
+
indexpage: "index.html"
181
136
182
-
# Exclude from processing.
183
-
# The following items will not be processed, by default. Create a custom list
0 commit comments