add docs

layer-3 · Mar 14, 2024 · 7459719 · 7459719
1 parent 2fedcc7
commit 7459719
Show file tree

Hide file tree

Showing 9 changed files with 62 additions and 4 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1 +1,7 @@
-charts/
+_site
+.sass-cache
+.jekyll-cache
+.jekyll-metadata
+vendor
+Gemfile
+Gemfile.lock
diff --git a/404.md b/404.md
@@ -0,0 +1,4 @@
+## 404
+
+**Page not found :(**
+The requested page could not be found.
diff --git a/README.md b/README.md
@@ -1,13 +1,13 @@
-# Yellow Stack
-
 ## Charts Usage
 
 [Helm](https://helm.sh) must be installed to use the charts.  Please refer to
 Helm's [documentation](https://helm.sh/docs) to get started.
 
 Once Helm has been set up correctly, add the repo as follows:
 
-  helm repo add yellow-stack https://layer-3.github.io/stack
+```sh
+helm repo add yellow-stack https://layer-3.github.io/stack
+```
 
 If you had already added this repo earlier, run `helm repo update` to retrieve
 the latest versions of the packages.  You can then run `helm search repo

diff --git a/_config.yml b/_config.yml
@@ -0,0 +1,23 @@
+title: Yellow Stack
+description: >- # this means to ignore newlines until "baseurl:"
+  Write an awesome description for your new site here. You can edit this
+  line in _config.yml. It will appear in your document head meta (for
+  Google search results) and in your feed.xml site description.
+twitter_username: Yellow
+github_username:  layer-3
+
+defaults:
+  - scope:
+      path: ""
+    values:
+      layout: "default"
+
+lsi: false
+safe: true
+incremental: false
+highlighter: rouge
+gist:
+  noscript: false
+kramdown:
+  math_engine: mathjax
+  syntax_highlighter: rouge
diff --git a/_data/docs.yml b/_data/docs.yml
@@ -0,0 +1,2 @@
+- title: Docs
+  url: /docs
diff --git a/_includes/head.html b/_includes/head.html
@@ -0,0 +1,7 @@
+<head>
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <!-- <link rel="stylesheet" href="{{ "/assets/main.css" | relative_url }}"> -->
+  <link rel="shortcut icon" type="image/ico" href="/assets/favicon.ico">
+</head>
diff --git a/_layouts/default.html b/_layouts/default.html
@@ -0,0 +1,15 @@
+{% include head.html %}
+<body>
+    {{ content }}
+
+    Data:
+    {{ data.docs | inspect }}
+
+    {%- if data.docs.size > 0 -%}
+        <h2>Navigation</h2>
+        {% for doc in site.data.docs %}
+            <li><a href="{{ doc.url }}">{{ doc.title }}</a></li>
+        {% endfor %}
+    {%- endif -%}
+
+</body>
diff --git a/assets/favicon.ico b/assets/favicon.ico
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1 @@
+## Docs