Skip to content

Commit a0d7633

Browse files
committed
Move layout names over
1 parent b0b1a12 commit a0d7633

File tree

7 files changed

+8
-47
lines changed

7 files changed

+8
-47
lines changed

README.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,7 @@ This documentation takes on a lot of structure from something like the [MDN Web
55

66

77
## Building
8-
The `dev` and `prod` config files are remnants of an old use case for these docs – the `ircdocs` config file is what we use to build the site.
9-
10-
In the `ircdocs` and `dev` modes, the site will build a basic browsable version that can be viewed through the server that Jekyll sets up. In `prod` mode, what's output is instead the HTML and files that get plugged into other sites more cleanly.
8+
The `ircdocs` config file creates the main site. The `bare` config file exports the pages without headers/footers and is used when plugging the content into other sites.
119

1210
**when writing docs**
1311
```sh

_config-prod.yml renamed to _config-bare.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# mode is either dev or prod
2-
mode: prod
1+
# mode is either ircdocs or bare
2+
mode: bare
33

4-
# baseurl for prod is where they'll be stored
4+
# baseurl is where they'll be accessed
55
baseurl: '/devdocs'
66

77
# Files/Folders to exclude from the final output

_config-dev.yml

-37
This file was deleted.

_config-ircdocs.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# mode is either dev or prod
2-
mode: dev
1+
# mode is either ircdocs or bare
2+
mode: ircdocs
33

4-
# baseurl for dev is the root
4+
# baseurl is the root
55
baseurl: '/'
66

77
# Files/Folders to exclude from the final output

_layouts/default.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
---
22
layout: compress
33
---
4-
{% if site.mode == "dev" %}{% include layouts/dev-default.html %}{% else %}{% include layouts/prod-default.html %}{% endif %}
4+
{% if site.mode == "ircdocs" %}{% include layouts/ircdocs-default.html %}{% else %}{% include layouts/bare-default.html %}{% endif %}

0 commit comments

Comments
 (0)