Skip to content

Commit

Permalink
Initial branding changes
Browse files Browse the repository at this point in the history
  • Loading branch information
DanielOaks committed Jun 23, 2020
1 parent 61e1500 commit 9a189b1
Show file tree
Hide file tree
Showing 3 changed files with 66 additions and 29 deletions.
40 changes: 20 additions & 20 deletions Gemfile.lock
Original file line number Diff line number Diff line change
@@ -1,21 +1,22 @@
GEM
remote: https://rubygems.org/
specs:
addressable (2.5.2)
public_suffix (>= 2.0.2, < 4.0)
addressable (2.7.0)
public_suffix (>= 2.0.2, < 5.0)
colorator (1.1.0)
concurrent-ruby (1.1.3)
concurrent-ruby (1.1.6)
em-websocket (0.5.1)
eventmachine (>= 0.12.9)
http_parser.rb (~> 0.6.0)
eventmachine (1.2.7)
ffi (1.9.25)
ffi (1.13.1)
forwardable-extended (2.6.0)
git (1.5.0)
git (1.7.0)
rchardet (~> 1.8)
http_parser.rb (0.6.0)
i18n (0.9.5)
concurrent-ruby (~> 1.0)
jekyll (3.8.5)
jekyll (3.8.7)
addressable (~> 2.4)
colorator (~> 1.0)
em-websocket (~> 0.5)
Expand All @@ -30,27 +31,26 @@ GEM
safe_yaml (~> 1.0)
jekyll-sass-converter (1.5.2)
sass (~> 3.4)
jekyll-watch (2.1.2)
jekyll-watch (2.2.1)
listen (~> 3.0)
kramdown (1.17.0)
liquid (4.0.1)
listen (3.1.5)
rb-fsevent (~> 0.9, >= 0.9.4)
rb-inotify (~> 0.9, >= 0.9.7)
ruby_dep (~> 1.2)
liquid (4.0.3)
listen (3.2.1)
rb-fsevent (~> 0.10, >= 0.10.3)
rb-inotify (~> 0.9, >= 0.9.10)
mercenary (0.3.6)
octopress-hooks (2.6.2)
jekyll (>= 2.0)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
public_suffix (3.0.3)
rb-fsevent (0.10.3)
rb-inotify (0.9.10)
ffi (>= 0.5.0, < 2)
rouge (3.3.0)
ruby_dep (1.5.0)
safe_yaml (1.0.4)
sass (3.7.2)
public_suffix (4.0.5)
rb-fsevent (0.10.4)
rb-inotify (0.10.1)
ffi (~> 1.0)
rchardet (1.8.0)
rouge (3.20.0)
safe_yaml (1.0.5)
sass (3.7.4)
sass-listen (~> 4.0.0)
sass-listen (4.0.0)
rb-fsevent (~> 0.9, >= 0.9.4)
Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
# IRC Foundation Developer Docs
This set of documentation is hosted by the IRC Foundation, describing the IRC (Internet Relay Chat) protocol in detail. The docs here are written to give developers a good footing when writing software that uses or interacts with IRC.
# IRC Developer Docs
This set of documentation describes the IRC (Internet Relay Chat) protocol. The docs are written to give developers a good footing when writing software that uses or interacts with IRC.

This documentation takes on a lot of structure from something like the [MDN Web Docs](https://developer.mozilla.org/en-US/), which documents web technology instead.


## Building
Primarily, these docs are meant to be plugged into the proper IRC Foundation website. However, when developing that's irritating to do so instead we support building the site in two different modes – `dev` and `prod`.
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.

In `dev` mode, 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 the Foundation site.
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.

**dev**
**when writing docs**
```sh
bundle exec jekyll serve -w --config _config-dev.yml
bundle exec jekyll serve -w --config _config-ircdocs.yml
```

**prod**
**building**
```sh
bundle exec jekyll b --config _config-prod.yml
bundle exec jekyll b --config _config-ircdocs.yml
```


Expand All @@ -43,7 +43,7 @@ Some stuff I want to describe very explicitly in future include:
Here are some other IRC references that devs may find useful:

- [IRCv3 Working Group](https://ircv3.net/)
- [ircdocs](http://ircdocs.horse/)
- [ircdocs](http://ircdocs.horse/) generally


## What can I do with this?
Expand Down
37 changes: 37 additions & 0 deletions _config-ircdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# mode is either dev or prod
mode: dev

# baseurl for dev is the root
baseurl: '/'

# Files/Folders to exclude from the final output
exclude:
- .sass-cache
- CNAME
- config.rb
- Gemfile
- Gemfile.lock
- README.md
- vendor
- CONTRIBUTING.md

compress_html:
clippings: []
comments: ["<!-- ", " -->"]
endings: []
ignore:
envs: [local]
blanklines: true
profile: false
startings: []

sass:
sass_dir: css

permalink: none

highlighter: rouge
markdown: kramdown

ghcommit: "https://github.com/ircdocs/dd/commit/"
ghrepo: "https://github.com/ircdocs/dd/blob/master/"

0 comments on commit 9a189b1

Please sign in to comment.