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 Oct 11, 2019. It is now read-only.
Copy file name to clipboardExpand all lines: configure.md
+11-14Lines changed: 11 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,29 +4,26 @@ title: Configure
4
4
nav: configure
5
5
---
6
6
7
-
# Configuration of code-gov-web
8
-
code-gov-web is configurable. To set up your own site, you'll have to configure your `CNAME`, `code-gov-config.json`, and `privacy-policy.md`. More details are below.
7
+
# Configuration of code-gov-front-end
8
+
code-gov-front-end is configurable. To set up your own site, you'll have to configure your `site.json`, and `privacy-policy.md`. More details are below.
9
9
10
-
# Domain
11
-
If you want to host code-gov-web on your own domain, you'll have to change the CNAME file found at [code-gov-web/config/CNAME](https://github.com/GSA/code-gov-web/blob/master/config/CNAME)
12
-
13
-
# code-gov-config.json
14
-
You can customize the styling, content and much more by adding to and updating the `code-gov-config.json` file found at [code-gov-web/config/code-gov-config.json](https://github.com/GSA/code-gov-web/blob/master/config/code-gov-config.json). You can also see examples of configurations in [code-gov-web/config/examples](https://github.com/GSA/code-gov-web/tree/master/config/examples).
10
+
# site.json
11
+
You can customize the styling, content and much more by adding to and updating the `site.json` file found at [code-gov-front-end/config/site.json](https://github.com/GSA/code-gov-front-end/blob/master/config/site/site.json). You can also see examples of configurations in [code-gov-front-end/config/examples](https://github.com/GSA/code-gov-front-end/tree/master/config/site/examples).
15
12
16
13
## title
17
-
To change the title of the website change the `title` property in `code-gov-web/config/code-gov-config.json`
14
+
To change the title of the website change the `title` property in `code-gov-front-end/config/site.json`
18
15
19
16
## api
20
-
code-gov-web is the front-end and needs to communicate with a backend. You can specify the base endpoint and api key. For example, [code.gov](https://code.gov) sets `base` to `https://api.code.gov/` and sets `key` to our public api key.
17
+
code-gov-front-end is the front-end and needs to communicate with a backend. You can specify the base endpoint and api key. For example, [code.gov](https://code.gov) sets `base` to `https://api.code.gov/` and sets `key` to our public api key.
21
18
22
19
## style
23
-
You can also configure the style sheets that your version of code-gov-web uses. The `style` property takes a value of the name of the npm package to use for styles. The easiest way to create your own style is to fork [code-gov-style](https://github.com/GSA/code-gov-style) and npm install it into your version.
20
+
You can also configure the style sheets that your version of code-gov-front-end uses. The `style` property takes a value of the name of the npm package to use for styles. The easiest way to create your own style is to fork [code-gov-style](https://github.com/GSA/code-gov-style) and npm install it into your version.
24
21
25
22
## twitter handle
26
23
You can add the handle for your twitter account. This is used to generate the link for the Twitter icon in the top right of each page.
27
24
28
25
## content
29
-
The largest part of the [code-gov-config.json](https://github.com/GSA/code-gov-web/blob/master/config/code-gov-config.json) is the `content` section. In it, you can configure most of the text that appears on your site.
26
+
The largest part of the [site.json](https://github.com/GSA/code-gov-front-end/blob/master/config/site/site.json) is the `content` section. In it, you can configure most of the text that appears on your site.
30
27
31
28
### header
32
29
Under header you can specify the logo used in the top menu bar and the different links that appear in this menu.
@@ -77,13 +74,13 @@ You can also add a disclaimer that says you can't guarantee that features are ro
77
74
```
78
75
79
76
# privacy policy
80
-
In order to change the privacy policy that appears on the site, just edit [privacy-policy.md](https://github.com/GSA/code-gov-web/blob/master/src/app/components/privacy-policy/privacy-policy.md). It's in markdown. Here's a guide on how to write markdown: https://guides.github.com/features/mastering-markdown/.
77
+
In order to change the privacy policy that appears on the site, just edit [privacy-policy.md](https://github.com/GSA/code-gov-front-end/blob/master/config/site/docs/privacy-policy.md). It's in markdown. Here's a guide on how to write markdown: https://guides.github.com/features/mastering-markdown/.
81
78
82
79
# more soon
83
-
There's many other ways to customize code-gov-web. More documentation coming soon!
80
+
There's many other ways to customize code-gov-front-end. More documentation coming soon!
84
81
85
82
# contact
86
83
If you have any questions, you can post an issue on GitHub or email us at code@gsa.gov
87
84
88
85
---
89
-
Note: cross posted from [https://github.com/GSA/code-gov-web/blob/master/CONFIGURATION.md](https://github.com/GSA/code-gov-web/blob/master/CONFIGURATION.md)
86
+
Note: cross posted from [https://github.com/GSA/code-gov-front-end/blob/master/CONFIGURATION.md](https://github.com/GSA/code-gov-front-end/blob/master/CONFIGURATION.md)
0 commit comments