Skip to content
This repository was archived by the owner on Oct 19, 2024. It is now read-only.

Commit 76df4fc

Browse files
calvellidoserras
calvellido
authored and
serras
committed
Docs initial website 🖨 (#53)
1 parent 9dab396 commit 76df4fc

Some content is hidden

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

54 files changed

+2379
-12
lines changed

‎.gitignore

+13
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,16 @@ stack*.yaml.lock
33
*~
44
dist
55
*.pyc
6+
7+
## User files
8+
.DS_Store
9+
10+
## Jekyll
11+
_site
12+
.sass-cache
13+
.jekyll-metadata
14+
.jekyll-cache
15+
16+
## Ruby environment normalization:
17+
.bundle/
18+
/docs/vendor/

‎docs/Gemfile

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
source "https://rubygems.org"
2+
3+
gem "jekyll", ">= 4.0.0"

‎docs/Gemfile.lock

+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
GEM
2+
remote: https://rubygems.org/
3+
specs:
4+
addressable (2.7.0)
5+
public_suffix (>= 2.0.2, < 5.0)
6+
colorator (1.1.0)
7+
concurrent-ruby (1.1.5)
8+
em-websocket (0.5.1)
9+
eventmachine (>= 0.12.9)
10+
http_parser.rb (~> 0.6.0)
11+
eventmachine (1.2.7)
12+
ffi (1.11.3)
13+
forwardable-extended (2.6.0)
14+
http_parser.rb (0.6.0)
15+
i18n (1.7.0)
16+
concurrent-ruby (~> 1.0)
17+
jekyll (4.0.0)
18+
addressable (~> 2.4)
19+
colorator (~> 1.0)
20+
em-websocket (~> 0.5)
21+
i18n (>= 0.9.5, < 2)
22+
jekyll-sass-converter (~> 2.0)
23+
jekyll-watch (~> 2.0)
24+
kramdown (~> 2.1)
25+
kramdown-parser-gfm (~> 1.0)
26+
liquid (~> 4.0)
27+
mercenary (~> 0.3.3)
28+
pathutil (~> 0.9)
29+
rouge (~> 3.0)
30+
safe_yaml (~> 1.0)
31+
terminal-table (~> 1.8)
32+
jekyll-sass-converter (2.0.1)
33+
sassc (> 2.0.1, < 3.0)
34+
jekyll-watch (2.2.1)
35+
listen (~> 3.0)
36+
kramdown (2.1.0)
37+
kramdown-parser-gfm (1.1.0)
38+
kramdown (~> 2.0)
39+
liquid (4.0.3)
40+
listen (3.2.1)
41+
rb-fsevent (~> 0.10, >= 0.10.3)
42+
rb-inotify (~> 0.9, >= 0.9.10)
43+
mercenary (0.3.6)
44+
pathutil (0.16.2)
45+
forwardable-extended (~> 2.6)
46+
public_suffix (4.0.1)
47+
rb-fsevent (0.10.3)
48+
rb-inotify (0.10.0)
49+
ffi (~> 1.0)
50+
rouge (3.14.0)
51+
safe_yaml (1.0.5)
52+
sassc (2.2.1)
53+
ffi (~> 1.9)
54+
terminal-table (1.8.0)
55+
unicode-display_width (~> 1.1, >= 1.1.1)
56+
unicode-display_width (1.6.0)
57+
58+
PLATFORMS
59+
ruby
60+
61+
DEPENDENCIES
62+
jekyll (>= 4.0.0)
63+
64+
BUNDLED WITH
65+
2.0.1

‎docs/README.md

+27-12
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,29 @@
11
# Docs for Mu-Haskell
22

3-
Mu-Haskell is a set of packages that help you build both servers and clients for (micro)services. The main goal of Mu-Haskell is to make you focus on your domain logic, instead of worrying about format and protocol issues.
4-
5-
* [Introduction](intro.md)
6-
* [Schemas](schema.md)
7-
* [Registry](registry.md)
8-
* [Services and servers](rpc.md)
9-
* [gRPC servers and clients](grpc.md)
10-
* [Streams](stream.md)
11-
* [Databases](db.md), including resource pools
12-
* Integration with other libraries
13-
* [Using transformers](transformer.md): look here for logging
14-
* [WAI Middleware](middleware.md): look here for metrics
3+
The documentation is built through a Jekyll site as base.
4+
5+
## Prerequisites
6+
7+
* You need to have [ruby >= 2.4.0](https://rvm.io/) installed on your system.
8+
* [Bundler >= 2](https://bundler.io/v2.0/guides/bundler_2_upgrade.html) is also needed.
9+
10+
11+
## Building the docs
12+
13+
To preview the site locally, execute the following command from the project root dir. This will install website dependencies under `docs/vendor/bundle`:
14+
15+
```bash
16+
bundle install --gemfile docs/Gemfile --path vendor/bundle
17+
```
18+
19+
Then, through this command, you will run the locally installed Jekyll instance to serve the site:
20+
21+
22+
```bash
23+
BUNDLE_GEMFILE=./docs/Gemfile bundle exec jekyll serve -s docs -b /mu-haskell
24+
```
25+
26+
27+
Finally, to have a look at the site, visit:
28+
29+
http://localhost:4000/mu-haskell

‎docs/_config.yml

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
title: Mu-Haskell
2+
#-------------------------
3+
name: Mu-Haskell
4+
#-------------------------
5+
description: Lorem ipusm
6+
#-------------------------
7+
author: 47 Degrees
8+
keywords: functional-programming, monads, monad-transformers, functional-data-structure, swift, bow, fp-types, adt, free-monads, tagless-final, mtl, for-comprehension, category-theory
9+
#-------------------------
10+
url: https://www.47deg.com
11+
#-------------------------
12+
markdown: kramdown
13+
sass:
14+
sass_dir: _sass
15+
style: compressed
16+
sourcemap: never
17+
#-------------------------
18+
permalink: pretty
19+
#-------------------------
20+
exclude: ['config.ru', 'Gemfile', 'Gemfile.lock', 'vendor', 'Procfile', 'Rakefile']
21+
#-------------------------

‎docs/_data/menu.yml

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
nav:
2+
- title: Documentation
3+
url: /
4+
5+
- title: Github
6+
url: https://github.com/higherkindness/mu-haskell
7+
8+
- title: License
9+
url: https://github.com/higherkindness/mu-haskell/blob/master/LICENSE

‎docs/_data/sidebar.yml

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
options:
2+
- title: Start
3+
url: /
4+
5+
- title: Introduction
6+
url: intro/
7+
8+
- title: Schemas
9+
url: schema/
10+
nested_options:
11+
- title: Registry
12+
url: registry/
13+
14+
- title: Services and servers
15+
url: rpc/
16+
nested_options:
17+
- title: gRPC
18+
url: grpc/
19+
20+
- title: Streams
21+
url: stream/
22+
23+
- title: Databases
24+
url: db/
25+
26+
- title: Integrations
27+
nested_options:
28+
- title: Transformers
29+
url: transformer/
30+
31+
- title: Middleware
32+
url: middleware/

‎docs/_includes/_doc.html

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
<main id="site-doc">
2+
<div class="doc-header">
3+
<button
4+
id="menu-toggle"
5+
type="button"
6+
class="button doc-toggle"
7+
title="Toggle">
8+
<img src="{{ site.baseurl }}/img/sidebar-icon-open.svg" alt="Toggle">
9+
</button>
10+
</div>
11+
<div class="doc-content">
12+
{{ content }}
13+
</div>
14+
</main>

‎docs/_includes/_footer.html

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<div id="site-footer">
2+
<div class="wrapper">
3+
<div class="footer-flex">
4+
<div class="footer-dev">
5+
<p>mu-haskell is designed and developed by
6+
<a href="https://github.com/higherkindness/mu-haskell/" target="_blank" rel="noopener noreferrer">{{ site.name }}</a>
7+
with support from <a href="https://www.47deg.com/" target="_blank" rel="noopener noreferrer">47 Degrees</a></p>
8+
</div>
9+
<ul class="footer-menu">
10+
{% for item in site.data.menu.nav %}
11+
<li class="footer-menu-item">
12+
<a href="{{ item.url | relative_url }}"
13+
title="{{ item.title }}"
14+
target="_blank" rel="noopener noreferrer">
15+
{{ item.title }}
16+
</a>
17+
</li>
18+
{% endfor %}
19+
</ul>
20+
</div>
21+
</div>
22+
</div>

‎docs/_includes/_head-docs.html

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<head>
2+
<meta charset="UTF-8">
3+
<title>{{site.name}}</title>
4+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
5+
<meta name="description" content="{{site.description}}">
6+
<meta name="keywords" content="{{site.keywords}}">
7+
8+
<meta property="og:image" content="" />
9+
<meta property="og:title" content="{{site.name}}" />
10+
<meta property="og:site_name" content="{{site.name}}" />
11+
<meta property="og:url" content="https://higherkindness.io/mu-haskell" />
12+
<meta property="og:type" content="website" />
13+
<meta property="og:description" content="{{site.description}}" />
14+
<meta property="og:keywords" content="{{site.keywords}}" />
15+
16+
<meta name="twitter:text:description" content="{{site.description}}" />
17+
<meta name="twitter:card" content="summary_large_image">
18+
<meta name="twitter:site" content="@47deg">
19+
<meta name="twitter:creator" content="@47deg">
20+
<meta name="twitter:image" content="" />
21+
22+
<script defer src="{{ '/js/docs.js' | relative_url }}"></script>
23+
24+
<!-- Favicon -->
25+
<link rel="shortcut icon" href="{{ '/img/favicon.png' | relative_url }}">
26+
27+
<!-- mu-haskell docs css -->
28+
<link rel="stylesheet" type="text/css" href="{{ '/css/docs.css' | relative_url }}">
29+
</head>

‎docs/_includes/_header.html

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<div id="site-header">
2+
<div class="wrapper">
3+
<div class="header-flex">
4+
<div class="header-text">
5+
<h1>IDL protocol management <span>IDL protocol management and distribution at the speed of light</span></h1>
6+
<a class="header-button" href="{{ 'docs/' | relative_url }}" title="Docs">Learn more</a>
7+
</div>
8+
<div class="header-image">
9+
<img src="{{ 'img/header-image.svg' | relative_url }}" alt="mu-haskell logo">
10+
</div>
11+
</div>
12+
</div>
13+
</div>

‎docs/_includes/_main.html

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<div id="site-main">
2+
<div class="wrapper">
3+
<div class="main-flex">
4+
{% for item in site.data.features.content %}
5+
<div class="main-item">
6+
<img src="{{ item.icon }}" alt="{{ item.title }}">
7+
<h2>{{ item.title }}</h2>
8+
<p>{{ item.description }}</p>
9+
</div>
10+
{% endfor %}
11+
</div>
12+
</div>
13+
</div>

‎docs/_includes/_nav.html

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
<nav id="site-nav">
2+
<div class="wrapper">
3+
<div class="nav-flex">
4+
<a class="nav-brand" title="mu-haskell" href="{{ site.baseurl }}/">
5+
<img src="{{ 'img/nav-brand.svg' | relative_url }}" title="{{ site.name }}">
6+
<span>{{ site.name }}</span>
7+
</a>
8+
<div class="nav-menu">
9+
<button
10+
class="button nav-icon-close"
11+
title="Close"
12+
onClick="toggleClass('.nav-menu', 'open');">
13+
<img src="{{ 'img/nav-icon-close.svg' | relative_url }}" alt="Close">
14+
</button>
15+
<ul>
16+
{% for item in site.data.menu.nav%}
17+
<li class="nav-menu-item">
18+
<a href="{{ item.url | relative_url }}" title="{{ item.title }}">{{ item.title }}</a>
19+
</li>
20+
{% endfor %}
21+
</ul>
22+
</div>
23+
24+
<button
25+
class="button nav-icon-open"
26+
title="Open"
27+
onClick="toggleClass('.nav-menu', 'open');">
28+
<img src="{{ '/img/nav-icon-open.svg' | relative_url }}" alt="Open">
29+
</button>
30+
</div>
31+
</div>
32+
</nav>

0 commit comments

Comments
 (0)