Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add setup for GitHub pages #865

Merged
merged 2 commits into from
Jul 10, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
title: OpenSearch SDK for Java
description: Extension Documentation
theme: jekyll-theme-minimal
logo: /assets/img/logo.png

sidenav:
- name: Design
link: DESIGN.md
- name: Developer Guide
link: DEVELOPER_GUIDE.md
- name: Create your first extension
link: CREATE_YOUR_FIRST_EXTENSION.md
- name: Plugin migration
link: PLUGIN_MIGRATION.md
9 changes: 9 additions & 0 deletions _includes/head_custom.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<!-- start custom head snippets, customize with your own _includes/head-custom.html file -->

<!-- Setup Google Analytics -->
<!-- {% include head-custom-google-analytics.html %} -->

<!-- You can set your favicon here -->
<link rel="shortcut icon" type="image/ico" href="{{ /assets/img/logo.png | relative_url }}" >

<!-- end custom head snippets -->
7 changes: 7 additions & 0 deletions _includes/sidenav.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<div class="link-wrapper">
<ul class="link">
{%- for topic in site.sidenav %}
<li><a href="{{ topic.link | replace:'.md','.html' }}">{{ topic.name }}</a></li>
{%- endfor %}
</ul>
</div>
40 changes: 40 additions & 0 deletions _layouts/default.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
<!DOCTYPE html>
<html lang="{{ site.lang | default: "en-US" }}">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">

{% seo %}
<link rel="stylesheet" href="{{ "/assets/css/style.css?v=" | append: site.github.build_revision | relative_url }}">
<!--[if lt IE 9]>
<script src="https://cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv.min.js"></script>
<![endif]-->
{% include head_custom.html %}
</head>
<body>
<div class="wrapper">
<div class="sidenav">
<header>
<h1><a href="{{ "/" | absolute_url }}">{{ site.title | default: site.github.repository_name }}</a></h1>
<p>{{ site.description | default: site.github.project_tagline }}</p>

{% if site.logo %}
<img src="{{site.logo | relative_url}}" width=50 alt="OpenSearch Logo" />
{% endif %}

{% include sidenav.html %}

<p><a href="{{ site.github.repository_url }}">opensearch-sdk-java repository</a></p>
<p><a href="https://opensearch.org/docs">OpenSearch user documentation</a></p>
</header>
</div>
<section>

{{ content }}

</section>
</div>
<script src="{{ "/assets/js/scale.fix.js" | relative_url }}"></script>
</body>
</html>
36 changes: 36 additions & 0 deletions assets/css/style.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
---

@import "{{ site.theme }}";

@media screen and (min-width: 1200px) {
.wrapper {
width:1200px;
margin:0 auto;
}

section {
width:900px;
float:right;
padding-bottom:50px;
}
}

.link-wrapper {
margin-top: 2.5rem;
}

ul.link {
list-style-type: none;
margin: 0;
padding: 0;
}

ul.link li + li {
margin-top: 1rem;
}

ul.link:last-child {
margin-bottom: 2.5rem;
}

Binary file added assets/img/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading