Skip to content

Commit 89a86ab

Browse files
dlucdluc
authored
Github Pages (#234)
## Motivation and Context (Why the change? What's the scenario?) Start documentation web site ## High level description (Approach, Design) * Create site structure, * Add Intro pages * Fix minor bugs while parsing tags with trailing empty chars
1 parent 0b8e4cc commit 89a86ab

Some content is hidden

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

83 files changed

+2497
-13
lines changed

‎.github/workflows/jekyll-gh-pages.yml

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Sample workflow for building and deploying a Jekyll site to GitHub Pages
2+
name: Deploy Jekyll with GitHub Pages dependencies preinstalled
3+
4+
on:
5+
# Runs on pushes targeting the default branch
6+
push:
7+
branches: ["main"]
8+
9+
# Allows you to run this workflow manually from the Actions tab
10+
workflow_dispatch:
11+
12+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
13+
permissions:
14+
contents: read
15+
pages: write
16+
id-token: write
17+
18+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
19+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
20+
concurrency:
21+
group: "pages"
22+
cancel-in-progress: false
23+
24+
jobs:
25+
# Build job
26+
build:
27+
runs-on: ubuntu-latest
28+
steps:
29+
- name: Checkout
30+
uses: actions/checkout@v4
31+
- name: Setup Pages
32+
uses: actions/configure-pages@v4
33+
- name: Build with Jekyll
34+
uses: actions/jekyll-build-pages@v1
35+
with:
36+
source: ./docs/
37+
destination: ./_site
38+
- name: Upload artifact
39+
uses: actions/upload-pages-artifact@v3
40+
41+
# Deployment job
42+
deploy:
43+
environment:
44+
name: github-pages
45+
url: ${{ steps.deployment.outputs.page_url }}
46+
runs-on: ubuntu-latest
47+
needs: build
48+
steps:
49+
- name: Deploy to GitHub Pages
50+
id: deployment
51+
uses: actions/deploy-pages@v4

‎.vscode/settings.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"[csharp]": {
77
"editor.defaultFormatter": "ms-dotnettools.csharp",
88
"editor.codeActionsOnSave": {
9-
"source.fixAll": true
9+
"source.fixAll": "explicit"
1010
}
1111
},
1212
"editor.bracketPairColorization.enabled": true,

‎KernelMemory.sln

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,31 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "clients", "clients", "{371B
2424
EndProject
2525
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "docs", "docs", "{7BA7F1B2-19E2-46EB-B000-513EE2F65769}"
2626
ProjectSection(SolutionItems) = preProject
27-
docs\FAQ.md = docs\FAQ.md
28-
docs\SECURITY_FILTERS.md = docs\SECURITY_FILTERS.md
27+
docs\_config.local.yml = docs\_config.local.yml
28+
docs\_config.yml = docs\_config.yml
29+
docs\csharp.png = docs\csharp.png
30+
docs\service.md = docs\service.md
31+
docs\serverless.md = docs\serverless.md
32+
docs\security.md = docs\security.md
33+
docs\run.cmd = docs\run.cmd
34+
docs\quickstart.md = docs\quickstart.md
35+
docs\quickstart-swagger.png = docs\quickstart-swagger.png
36+
docs\quickstart-dotnet-run.png = docs\quickstart-dotnet-run.png
37+
docs\python.png = docs\python.png
38+
docs\packages.md = docs\packages.md
2939
docs\network.png = docs\network.png
40+
docs\logo.png = docs\logo.png
41+
docs\java.png = docs\java.png
42+
docs\index.md = docs\index.md
43+
docs\how-tos.md = docs\how-tos.md
44+
docs\Gemfile.lock = docs\Gemfile.lock
45+
docs\Gemfile = docs\Gemfile
46+
docs\features.md = docs\features.md
47+
docs\favicon.png = docs\favicon.png
48+
docs\FAQ.md = docs\FAQ.md
49+
docs\extensions.md = docs\extensions.md
50+
docs\concepts.md = docs\concepts.md
51+
docs\404.html = docs\404.html
3052
EndProjectSection
3153
EndProject
3254
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "examples", "examples", "{0A43C65C-6007-4BB4-B3FE-8D439FC91841}"

‎docs/.gitignore

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
_site
2+
.sass-cache
3+
.jekyll-cache
4+
.jekyll-metadata
5+
vendor
6+
_setup.txt

‎docs/404.html

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

‎docs/FAQ.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
nav_order: 90
3+
has_children: false
4+
title: F.A.Q.
5+
permalink: /faq
6+
layout: default
7+
---
18
# Kernel Memory F.A.Q.
29

310
### How do I integrate Kernel Memory with my application?

‎docs/Gemfile

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
source "https://rubygems.org"
2+
# Hello! This is where you manage which Jekyll version is used to run.
3+
# When you want to use a different version, change it below, save the
4+
# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
5+
#
6+
# bundle exec jekyll serve
7+
#
8+
# This will help ensure the proper Jekyll version is running.
9+
# Happy Jekylling!
10+
gem "jekyll", "~> 4.3.3"
11+
# This is the default theme for new Jekyll sites. You may change this to anything you like.
12+
gem "minima", "~> 2.5"
13+
# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
14+
# uncomment the line below. To upgrade, run `bundle update github-pages`.
15+
# gem "github-pages", group: :jekyll_plugins
16+
# If you have any plugins, put them here!
17+
group :jekyll_plugins do
18+
gem "jekyll-feed", "~> 0.12"
19+
end
20+
21+
# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
22+
# and associated library.
23+
platforms :mingw, :x64_mingw, :mswin, :jruby do
24+
gem "tzinfo", ">= 1", "< 3"
25+
gem "tzinfo-data"
26+
end
27+
28+
# Performance-booster for watching directories on Windows
29+
gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]
30+
31+
# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem
32+
# do not have a Java counterpart.
33+
gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]
34+
35+
gem "just-the-docs", "~> 0.7.0"
36+
37+
# ====================================
38+
# source "https://rubygems.org"
39+
# gemspec
40+
41+
# gem "jekyll", "~> 4.3.3"
42+
# gem "just-the-docs", "~> 0.7.0"
43+
44+
# gem "jekyll-github-metadata", ">= 2.15"
45+
46+
# gem "jekyll-include-cache", group: :jekyll_plugins
47+
48+
# gem "html-proofer", "~> 5.0", :group => :development

‎docs/Gemfile.lock

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
GEM
2+
remote: https://rubygems.org/
3+
specs:
4+
addressable (2.8.6)
5+
public_suffix (>= 2.0.2, < 6.0)
6+
colorator (1.1.0)
7+
concurrent-ruby (1.2.2)
8+
em-websocket (0.5.3)
9+
eventmachine (>= 0.12.9)
10+
http_parser.rb (~> 0)
11+
eventmachine (1.2.7)
12+
ffi (1.16.3)
13+
forwardable-extended (2.6.0)
14+
google-protobuf (3.25.1)
15+
google-protobuf (3.25.1-x86_64-darwin)
16+
http_parser.rb (0.8.0)
17+
i18n (1.14.1)
18+
concurrent-ruby (~> 1.0)
19+
jekyll (4.3.3)
20+
addressable (~> 2.4)
21+
colorator (~> 1.0)
22+
em-websocket (~> 0.5)
23+
i18n (~> 1.0)
24+
jekyll-sass-converter (>= 2.0, < 4.0)
25+
jekyll-watch (~> 2.0)
26+
kramdown (~> 2.3, >= 2.3.1)
27+
kramdown-parser-gfm (~> 1.0)
28+
liquid (~> 4.0)
29+
mercenary (>= 0.3.6, < 0.5)
30+
pathutil (~> 0.9)
31+
rouge (>= 3.0, < 5.0)
32+
safe_yaml (~> 1.0)
33+
terminal-table (>= 1.8, < 4.0)
34+
webrick (~> 1.7)
35+
jekyll-feed (0.17.0)
36+
jekyll (>= 3.7, < 5.0)
37+
jekyll-include-cache (0.2.1)
38+
jekyll (>= 3.7, < 5.0)
39+
jekyll-sass-converter (3.0.0)
40+
sass-embedded (~> 1.54)
41+
jekyll-seo-tag (2.8.0)
42+
jekyll (>= 3.8, < 5.0)
43+
jekyll-watch (2.2.1)
44+
listen (~> 3.0)
45+
just-the-docs (0.7.0)
46+
jekyll (>= 3.8.5)
47+
jekyll-include-cache
48+
jekyll-seo-tag (>= 2.0)
49+
rake (>= 12.3.1)
50+
kramdown (2.4.0)
51+
rexml
52+
kramdown-parser-gfm (1.1.0)
53+
kramdown (~> 2.0)
54+
liquid (4.0.4)
55+
listen (3.8.0)
56+
rb-fsevent (~> 0.10, >= 0.10.3)
57+
rb-inotify (~> 0.9, >= 0.9.10)
58+
mercenary (0.4.0)
59+
minima (2.5.1)
60+
jekyll (>= 3.5, < 5.0)
61+
jekyll-feed (~> 0.9)
62+
jekyll-seo-tag (~> 2.1)
63+
pathutil (0.16.2)
64+
forwardable-extended (~> 2.6)
65+
public_suffix (5.0.4)
66+
rake (13.1.0)
67+
rb-fsevent (0.11.2)
68+
rb-inotify (0.10.1)
69+
ffi (~> 1.0)
70+
rexml (3.2.6)
71+
rouge (4.2.0)
72+
safe_yaml (1.0.5)
73+
sass-embedded (1.69.6)
74+
google-protobuf (~> 3.25)
75+
rake (>= 13.0.0)
76+
sass-embedded (1.69.6-x86_64-darwin)
77+
google-protobuf (~> 3.25)
78+
terminal-table (3.0.2)
79+
unicode-display_width (>= 1.1.1, < 3)
80+
unicode-display_width (2.5.0)
81+
webrick (1.8.1)
82+
83+
PLATFORMS
84+
ruby
85+
x86_64-darwin-23
86+
87+
DEPENDENCIES
88+
http_parser.rb (~> 0.6.0)
89+
jekyll (~> 4.3.3)
90+
jekyll-feed (~> 0.12)
91+
just-the-docs (~> 0.7.0)
92+
minima (~> 2.5)
93+
tzinfo (>= 1, < 3)
94+
tzinfo-data
95+
wdm (~> 0.1.1)
96+
97+
BUNDLED WITH
98+
2.5.3

‎docs/_config.local.yml

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
# Config for local Jekyll tests
2+
theme: just-the-docs
3+
4+
# ==================================================
5+
# == everything below is the same as _config.yaml ==
6+
# ==================================================
7+
8+
title: Kernel Memory
9+
description: >-
10+
Index and query any data using LLM and natural language, tracking sources and
11+
showing citations. Kernel Memory (KM) is a multi-modal AI Service specialized
12+
in the efficient indexing of datasets through custom continuous data hybrid
13+
pipelines, with support for Retrieval Augmented Generation (RAG), synthetic
14+
memory, prompt engineering, and custom semantic memory processing.
15+
baseurl: "/kernel-memory"
16+
url: ""
17+
18+
favicon_ico: "/favicon.png"
19+
enable_copy_code_button: true
20+
heading_anchors: true
21+
color_scheme: custom
22+
23+
callouts:
24+
highlight:
25+
color: yellow
26+
console:
27+
color: green
28+
important:
29+
title: Important
30+
color: blue
31+
new:
32+
title: New
33+
color: green
34+
note:
35+
title: Note
36+
color: purple
37+
warning:
38+
title: Warning
39+
color: red
40+
41+
nav_external_links:
42+
- title: KM on GitHub
43+
url: https://github.com/microsoft/kernel-memory
44+
- title: KM on Discord
45+
url: https://aka.ms/KMDiscord
46+
47+
aux_links:
48+
"GitHub":
49+
- "https://github.com/microsoft/kernel-memory"
50+
"Discord":
51+
- "https://aka.ms/KMDiscord"
52+
53+
back_to_top: false
54+
back_to_top_text: "Back to top"
55+
56+
gh_edit_link: true
57+
gh_edit_link_text: "Edit this page"
58+
gh_edit_repository: "https://github.com/microsoft/kernel-memory"
59+
gh_edit_branch: "main"
60+
gh_edit_source: docs
61+
gh_edit_view_mode: "tree"
62+
63+
search_enabled: true
64+
search:
65+
# Split pages into sections that can be searched individually # Supports 1 - 6, default: 6
66+
heading_level: 6
67+
# Maximum amount of previews per search result # Default: 3
68+
previews: 3
69+
# Maximum amount of words to display before a matched word in the preview # Default: 5
70+
preview_words_before: 6
71+
# Maximum amount of words to display after a matched word in the preview # Default: 10
72+
preview_words_after: 10
73+
# Set the search token separator # Default: /[\s\-/]+/ # Example: enable support for hyphenated search words
74+
tokenizer_separator: /[\s/]+/
75+
# Display the relative url in search results # Supports true (default) or false
76+
rel_url: false
77+
# Enable or disable the search button that appears in the bottom right corner of every page # Supports true or false (default)
78+
button: true
79+
80+
mermaid:
81+
# See https://cdn.jsdelivr.net/npm/mermaid/
82+
version: "10.6.1"

0 commit comments

Comments
 (0)