Skip to content

Commit 26849ba

Browse files
committed
* Docs theme to match ENiGMA website
* New docs layout ready for github pages serving * Tonnes of new docs * Update gitignore * Probably other stuff too
1 parent 06ea2d1 commit 26849ba

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

62 files changed

+1977
-813
lines changed

.gitignore

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,7 @@
55
logs/
66
db/
77
dropfiles/
8-
node_modules/
8+
node_modules/
9+
docs/_site/
10+
docs/.sass-cache/
11+
`

docs/404.html

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
layout: default
3+
---
4+
5+
<style type="text/css" media="screen">
6+
.container {
7+
margin: 10px auto;
8+
max-width: 600px;
9+
text-align: center;
10+
}
11+
h1 {
12+
margin: 30px 0;
13+
font-size: 4em;
14+
line-height: 1;
15+
letter-spacing: -1px;
16+
}
17+
</style>
18+
19+
<div class="container">
20+
<h1>404</h1>
21+
22+
<p><strong>Page not found :(</strong></p>
23+
<p>The requested page could not be found.</p>
24+
</div>

docs/Gemfile

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
source "https://rubygems.org"
2+
3+
# Hello! This is where you manage which Jekyll version is used to run.
4+
# When you want to use a different version, change it below, save the
5+
# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
6+
#
7+
# bundle exec jekyll serve
8+
#
9+
# This will help ensure the proper Jekyll version is running.
10+
# Happy Jekylling!
11+
gem "jekyll", "~> 3.7.0"
12+
13+
# This is the default theme for new Jekyll sites. You may change this to anything you like.
14+
gem "hacker"
15+
16+
# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
17+
# uncomment the line below. To upgrade, run `bundle update github-pages`.
18+
# gem "github-pages", group: :jekyll_plugins
19+
20+
# If you have any plugins, put them here!
21+
group :jekyll_plugins do
22+
gem "jekyll-feed", "~> 0.6"
23+
gem 'jekyll-seo-tag'
24+
gem 'jekyll-theme-hacker'
25+
gem 'jekyll-sitemap'
26+
gem 'jemoji'
27+
end
28+
29+
# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
30+
gem "tzinfo-data", platforms: [:mingw, :mswin, :x64_mingw, :jruby]
31+

docs/Gemfile.lock

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
GEM
2+
remote: https://rubygems.org/
3+
specs:
4+
activesupport (4.2.9)
5+
i18n (~> 0.7)
6+
minitest (~> 5.1)
7+
thread_safe (~> 0.3, >= 0.3.4)
8+
tzinfo (~> 1.1)
9+
addressable (2.5.2)
10+
public_suffix (>= 2.0.2, < 4.0)
11+
colorator (1.1.0)
12+
concurrent-ruby (1.0.5)
13+
em-websocket (0.5.1)
14+
eventmachine (>= 0.12.9)
15+
http_parser.rb (~> 0.6.0)
16+
eventmachine (1.2.5)
17+
ffi (1.9.18)
18+
forwardable-extended (2.6.0)
19+
gemoji (3.0.0)
20+
hacker (0.0.1)
21+
html-pipeline (2.7.1)
22+
activesupport (>= 2)
23+
nokogiri (>= 1.4)
24+
http_parser.rb (0.6.0)
25+
i18n (0.9.1)
26+
concurrent-ruby (~> 1.0)
27+
jekyll (3.7.0)
28+
addressable (~> 2.4)
29+
colorator (~> 1.0)
30+
em-websocket (~> 0.5)
31+
i18n (~> 0.7)
32+
jekyll-sass-converter (~> 1.0)
33+
jekyll-watch (~> 2.0)
34+
kramdown (~> 1.14)
35+
liquid (~> 4.0)
36+
mercenary (~> 0.3.3)
37+
pathutil (~> 0.9)
38+
rouge (>= 1.7, < 4)
39+
safe_yaml (~> 1.0)
40+
jekyll-feed (0.9.2)
41+
jekyll (~> 3.3)
42+
jekyll-sass-converter (1.5.1)
43+
sass (~> 3.4)
44+
jekyll-seo-tag (2.4.0)
45+
jekyll (~> 3.3)
46+
jekyll-sitemap (1.1.1)
47+
jekyll (~> 3.3)
48+
jekyll-theme-hacker (0.1.0)
49+
jekyll (~> 3.5)
50+
jekyll-seo-tag (~> 2.0)
51+
jekyll-watch (2.0.0)
52+
listen (~> 3.0)
53+
jemoji (0.8.1)
54+
activesupport (~> 4.0, >= 4.2.9)
55+
gemoji (~> 3.0)
56+
html-pipeline (~> 2.2)
57+
jekyll (>= 3.0)
58+
kramdown (1.16.2)
59+
liquid (4.0.0)
60+
listen (3.1.5)
61+
rb-fsevent (~> 0.9, >= 0.9.4)
62+
rb-inotify (~> 0.9, >= 0.9.7)
63+
ruby_dep (~> 1.2)
64+
mercenary (0.3.6)
65+
mini_portile2 (2.3.0)
66+
minitest (5.11.1)
67+
nokogiri (1.8.1)
68+
mini_portile2 (~> 2.3.0)
69+
pathutil (0.16.1)
70+
forwardable-extended (~> 2.6)
71+
public_suffix (3.0.1)
72+
rb-fsevent (0.10.2)
73+
rb-inotify (0.9.10)
74+
ffi (>= 0.5.0, < 2)
75+
rouge (3.1.0)
76+
ruby_dep (1.5.0)
77+
safe_yaml (1.0.4)
78+
sass (3.5.5)
79+
sass-listen (~> 4.0.0)
80+
sass-listen (4.0.0)
81+
rb-fsevent (~> 0.9, >= 0.9.4)
82+
rb-inotify (~> 0.9, >= 0.9.7)
83+
thread_safe (0.3.6)
84+
tzinfo (1.2.4)
85+
thread_safe (~> 0.1)
86+
87+
PLATFORMS
88+
ruby
89+
90+
DEPENDENCIES
91+
hacker
92+
jekyll (~> 3.7.0)
93+
jekyll-feed (~> 0.6)
94+
jekyll-seo-tag
95+
jekyll-sitemap
96+
jekyll-theme-hacker
97+
jemoji
98+
tzinfo-data
99+
100+
BUNDLED WITH
101+
1.16.1

docs/_config.yml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
title: ENiGMA½ BBS Software
2+
3+
description: >- # this means to ignore newlines until "baseurl:"
4+
ENiGMA½ BBS is modern open source BBS software with a nostalgic flair, written in Node.js.
5+
url:
6+
logo: /assets/images/enigma-logo.png
7+
8+
# Build settings
9+
markdown: kramdown
10+
theme: jekyll-theme-hacker
11+
plugins:
12+
- jekyll-feed
13+
- jekyll-seo-tag
14+
- jekyll-sitemap
15+
- jemoji
16+
17+
# Exclude from processing.
18+
# The following items will not be processed, by default. Create a custom list
19+
# to override the default setting.
20+
exclude:
21+
- Gemfile
22+
- Gemfile.lock
23+
- node_modules
24+
- vendor/bundle/
25+
- vendor/cache/
26+
- vendor/gems/
27+
- vendor/ruby/
28+
- .idea

docs/_includes/nav.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
- Installation
2+
- [Installation Methods](/installation/installation-methods)
3+
- [Install script](/installation/install-script)
4+
- [Docker](/installation/docker)
5+
- [Manual installation](/installation/manual)
6+
- [OS / Hardware Specific](/installation/os-hardware)
7+
- Raspberry Pi
8+
- Windows
9+
- [Your Network Setup](/installation/network)
10+
- [Testing Your Installation](/installation/testing)
11+
- [Production Installation](/installation/production)
12+
13+
- Configuration
14+
- [Creating Config Files](/configuration/creating-config)
15+
- [SysOp Setup](/configuration/sysop-setup)
16+
- [Editing hjson](/configuration/editing-hjson)
17+
- [config.hjson](/configuration/config-hjson)
18+
- [menu.hjson](/configuration/menu-hjson)
19+
- prompt.hjson
20+
- [Directory Structure](/configuration/directory-structure)
21+
- [Archivers](/configuration/archivers)
22+
- Scheduled jobs
23+
- SMTP
24+
25+
- File Base
26+
- [About](/filebase/)
27+
- [Configuring a File Area](/filebase/first-file-area)
28+
- [ACS model](/filebase/acs)
29+
- [Uploads](/filebase/uploads)
30+
- [Web Access](/filebase/web-access)
31+
- [TIC Support](/filebase/tic-support) (Importing from FTN networks)
32+
- Tips and tricks
33+
- Network mounts and symlinks
34+
35+
- Message Areas
36+
- [Configuring a Message Area](/messageareas/configuring-a-message-area)
37+
- [Message networks](/messageareas/message-networks)
38+
- [BSO Import & Export](/messageareas/bso-import-export)
39+
- [Netmail](/messageareas/netmail)
40+
41+
- Art
42+
- [General](/art/general)
43+
- [Themes](/art/themes)
44+
- [MCI Codes](/art/mci)
45+
46+
- Servers
47+
- Login Servers
48+
- [Telnet](/servers/telnet)
49+
- [SSH](/servers/ssh)
50+
- [WebSocket](/servers/websocket)
51+
- Build your own
52+
- Content Servers
53+
- [Web](/servers/web-server)
54+
55+
- Modding
56+
- [Local Doors](/modding/local-doors)
57+
- [Door Servers](/modding/door-servers)
58+
- DoorParty
59+
- BBSLink
60+
- Combatnet
61+
- Exodus
62+
- [Existing Mods](/modding/existing-mods)
63+
64+
- [Oputil](/oputil/)
65+
66+
- Troubleshooting
67+
- [Monitoring Logs](/troubleshooting/monitoring-logs)

docs/_layouts/default.html

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
<!DOCTYPE html>
2+
<html lang="en-US">
3+
<head>
4+
<meta charset='utf-8'>
5+
<meta http-equiv="X-UA-Compatible" content="chrome=1">
6+
<meta name="viewport" content="width=device-width, initial-scale=1">
7+
<link rel="stylesheet" href="{{ '/assets/css/style.css?v=' | append: site.github.build_revision | relative_url }}">
8+
<link rel="stylesheet" href="{{ '/assets/css/OverlayScrollbars.min.css?v=' | append: site.github.build_revision | relative_url }}">
9+
{% seo %}
10+
11+
</head>
12+
13+
<body>
14+
<a href="https://github.com/NuSkooler/enigma-bbs"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://camo.githubusercontent.com/e7bbb0521b397edbd5fe43e7f760759336b5e05f/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f6769746875622f726962626f6e732f666f726b6d655f72696768745f677265656e5f3030373230302e706e67" alt="Fork me on GitHub" data-canonical-src="https://s3.amazonaws.com/github/ribbons/forkme_right_green_007200.png"></a>
15+
<div class="sidebar" id="sidebar">
16+
<div class="container">
17+
<a href="/"><img src="/assets/images/enigma-logo.png" class="logo" /></a>
18+
</div>
19+
{% capture nav_include %}{% include nav.md %}{% endcapture %}
20+
{{ nav_include | markdownify }}
21+
</div>
22+
<div class="main_area">
23+
<div class="container">
24+
<section id="main_content">
25+
{{ content }}
26+
</section>
27+
</div>
28+
</div>
29+
30+
{% if site.google_analytics %}
31+
<script type="text/javascript">
32+
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
33+
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
34+
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
35+
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
36+
ga('create', '{{ site.google_analytics }}', 'auto');
37+
ga('send', 'pageview');
38+
</script>
39+
{% endif %}
40+
</body>
41+
</html>

docs/_layouts/page.html

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
layout: default
3+
---
4+
5+
<div class="page">
6+
<h1 class="page-title">{{ page.title }}</h1>
7+
{{ content }}
8+
</div>

docs/_layouts/post.html

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
layout: default
3+
---
4+
5+
<div class="post">
6+
<h1 class="post-title">{{ page.title }}</h1>
7+
<span class="post-date">{{ page.date | date_to_string }}</span>
8+
{{ content }}
9+
</div>
10+
11+
<div class="related">
12+
<h2>Related Posts</h2>
13+
<ul class="related-posts">
14+
{% for post in site.related_posts limit:3 %}
15+
<li>
16+
<h3>
17+
<a href="{{ post.url }}">
18+
{{ post.title }}
19+
<small>{{ post.date | date_to_string }}</small>
20+
</a>
21+
</h3>
22+
</li>
23+
{% endfor %}
24+
</ul>
25+
</div>

docs/_sass/_default_colors.scss

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
$apple-blossom: #ac4142;
2+
$alto: #d0d0d0;
3+
$bouquet: #aa759f;
4+
$enigma-purple: #8900aa;
5+
$chelsea-cucumber: #90a959;
6+
$cod-grey: #151515;
7+
$conifer: #b5e853;
8+
$dove-grey: #666;
9+
$gallery: #eaeaea;
10+
$grey: #888;
11+
$gulf-stream: #75b5aa;
12+
$hippie-blue: #6a9fb5;
13+
$potters-clay: #8f5536;
14+
$rajah: #f4bf75;
15+
$raw-sienna: #d28445;
16+
$silver-chalice: #aaa;

0 commit comments

Comments
 (0)