Skip to content

Commit 1ee51a1

Browse files
committed
Matlas Prototype
1 parent 1a2afe6 commit 1ee51a1

File tree

17 files changed

+743
-54
lines changed

17 files changed

+743
-54
lines changed

.DS_Store

0 Bytes
Binary file not shown.

.github/workflows/docs.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,11 @@ jobs:
3737
id: pages
3838
uses: actions/configure-pages@v4
3939

40+
- name: Install dependencies
41+
working-directory: docs
42+
run: |
43+
bundle install
44+
4045
- name: Build site
4146
working-directory: docs
4247
env:

docs/Gemfile

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
source "https://rubygems.org"
22

3-
gem "jekyll", "~> 4.2"
4-
gem "just-the-docs", "0.7.0"
5-
gem "webrick", "~> 1.7"
3+
gem "jekyll", "~> 4.3"
4+
gem "minima"
5+
gem "webrick", "~> 1.7"
6+
gem "jekyll-sass-converter"
7+
gem "jekyll-sitemap"
8+
gem "jekyll-feed"

docs/_config.yml

Lines changed: 49 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,61 @@
1+
# Site settings
12
title: matlas
23
description: Unified CLI for MongoDB Atlas and MongoDB databases
34
url: https://teabranch.github.io
45
baseurl: /matlas-cli
56

6-
theme: just-the-docs
7+
# Theme settings
8+
theme: minima
79

8-
search_enabled: true
9-
color_scheme: light
10+
# Build settings
11+
markdown: kramdown
12+
highlighter: rouge
13+
kramdown:
14+
syntax_highlighter: rouge
15+
syntax_highlighter_opts:
16+
css_class: 'highlight'
17+
span:
18+
line_numbers: false
19+
block:
20+
line_numbers: false
1021

11-
nav_external_links:
12-
- title: GitHub
13-
url: https://github.com/teabranch/matlas-cli
22+
# Plugins
23+
plugins:
24+
- jekyll-feed
25+
- jekyll-sitemap
26+
- jekyll-sass-converter
1427

28+
# Collections
29+
collections:
30+
docs:
31+
output: true
32+
permalink: /:collection/:name/
33+
34+
# Navigation
35+
navigation:
36+
- title: Home
37+
url: /
38+
- title: Authentication
39+
url: /auth/
40+
- title: Atlas Commands
41+
url: /atlas/
42+
- title: Database Commands
43+
url: /database/
44+
- title: Infrastructure
45+
url: /infra/
46+
47+
# Social links
48+
github_username: teabranch
49+
github_repository: matlas-cli
50+
51+
# Exclude from processing
1552
exclude:
1653
- vendor/
1754
- node_modules/
1855
- Gemfile
19-
- Gemfile.lock
56+
- Gemfile.lock
57+
- README.md
58+
59+
# Include files
60+
include:
61+
- _pages

docs/_includes/footer.html

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<footer class="site-footer">
2+
<div class="footer-content">
3+
<div class="footer-text">
4+
© {{ 'now' | date: '%Y' }} {{ site.title }}. Built with Jekyll.
5+
</div>
6+
7+
<div class="footer-links">
8+
<a href="https://github.com/{{ site.github_username }}/{{ site.github_repository }}" target="_blank" rel="noopener">GitHub</a>
9+
<a href="{{ '/feed.xml' | relative_url }}">RSS</a>
10+
</div>
11+
</div>
12+
</footer>

docs/_includes/navigation.html

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<nav class="site-nav">
2+
<div class="nav-container">
3+
<a href="{{ '/' | relative_url }}" class="nav-brand">{{ site.title }}</a>
4+
5+
<ul class="nav-links">
6+
{% for item in site.navigation %}
7+
<li>
8+
<a href="{{ item.url | relative_url }}">{{ item.title }}</a>
9+
</li>
10+
{% endfor %}
11+
<li>
12+
<a href="https://github.com/{{ site.github_username }}/{{ site.github_repository }}" target="_blank" rel="noopener">GitHub</a>
13+
</li>
14+
</ul>
15+
</div>
16+
</nav>

docs/_layouts/default.html

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6+
<meta name="viewport" content="width=device-width, initial-scale=1">
7+
8+
<title>{% if page.title %}{{ page.title | escape }} | {{ site.title | escape }}{% else %}{{ site.title | escape }}{% endif %}</title>
9+
<meta name="description" content="{% if page.excerpt %}{{ page.excerpt | strip_html | strip_newlines | truncate: 160 }}{% else %}{{ site.description }}{% endif %}">
10+
11+
<!-- CSS -->
12+
<link rel="stylesheet" href="{{ '/assets/css/style.css' | relative_url }}">
13+
14+
<!-- RSS -->
15+
<link rel="alternate" type="application/rss+xml" title="{{ site.title }}" href="{{ '/feed.xml' | relative_url }}">
16+
17+
<!-- Meta tags -->
18+
<meta name="author" content="{{ site.author }}">
19+
<meta name="twitter:card" content="summary">
20+
<meta name="twitter:title" content="{% if page.title %}{{ page.title | escape }}{% else %}{{ site.title | escape }}{% endif %}">
21+
<meta name="twitter:description" content="{% if page.excerpt %}{{ page.excerpt | strip_html | strip_newlines | truncate: 160 }}{% else %}{{ site.description }}{% endif %}">
22+
23+
<meta property="og:title" content="{% if page.title %}{{ page.title | escape }}{% else %}{{ site.title | escape }}{% endif %}">
24+
<meta property="og:description" content="{% if page.excerpt %}{{ page.excerpt | strip_html | strip_newlines | truncate: 160 }}{% else %}{{ site.description }}{% endif %}">
25+
<meta property="og:type" content="website">
26+
<meta property="og:url" content="{{ page.url | absolute_url }}">
27+
28+
<!-- Syntax highlighting -->
29+
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/github.min.css">
30+
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js"></script>
31+
<script>hljs.highlightAll();</script>
32+
</head>
33+
34+
<body>
35+
{% include navigation.html %}
36+
37+
<main class="main-content">
38+
<div class="container">
39+
{{ content }}
40+
</div>
41+
</main>
42+
43+
{% include footer.html %}
44+
45+
<!-- JavaScript -->
46+
<script src="{{ '/assets/js/main.js' | relative_url }}"></script>
47+
<script>
48+
// Add active class to current nav item
49+
document.addEventListener('DOMContentLoaded', function() {
50+
const currentPath = window.location.pathname;
51+
const navLinks = document.querySelectorAll('.nav-links a');
52+
53+
navLinks.forEach(link => {
54+
if (link.getAttribute('href') === currentPath ||
55+
(currentPath.includes(link.getAttribute('href')) && link.getAttribute('href') !== '/')) {
56+
link.classList.add('active');
57+
}
58+
});
59+
});
60+
</script>
61+
</body>
62+
</html>

docs/_layouts/home.html

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

docs/_layouts/page.html

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
layout: default
3+
---
4+
5+
<article class="page">
6+
<header class="page-header">
7+
<h1 class="page-title">{{ page.title }}</h1>
8+
{% if page.description %}
9+
<p class="page-description">{{ page.description }}</p>
10+
{% endif %}
11+
</header>
12+
13+
<div class="page-content">
14+
{{ content }}
15+
</div>
16+
</article>

0 commit comments

Comments
 (0)