Skip to content

Commit 9a6f97c

Browse files
Psychlist1972Psychlist1972
authored
Merge pull request #260 from microsoft/pete-dev
Mostly documentation
2 parents be951b8 + 59e1586 commit 9a6f97c

File tree

197 files changed

+27088
-993
lines changed

Some content is hidden

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

197 files changed

+27088
-993
lines changed

‎.github/workflows/pages.yml

+71
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# This workflow uses actions that are not certified by GitHub.
2+
# They are provided by a third-party and are governed by
3+
# separate terms of service, privacy policy, and support
4+
# documentation.
5+
6+
# Sample workflow for building and deploying a Jekyll site to GitHub Pages
7+
name: Deploy Jekyll site to Pages
8+
9+
on:
10+
push:
11+
branches:
12+
- "main"
13+
paths:
14+
- "docs/**"
15+
16+
# Allows you to run this workflow manually from the Actions tab
17+
workflow_dispatch:
18+
19+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
20+
permissions:
21+
contents: read
22+
pages: write
23+
id-token: write
24+
25+
# Allow one concurrent deployment
26+
concurrency:
27+
group: "pages"
28+
cancel-in-progress: true
29+
30+
jobs:
31+
# Build job
32+
build:
33+
runs-on: ubuntu-latest
34+
defaults:
35+
run:
36+
working-directory: docs
37+
steps:
38+
- name: Checkout
39+
uses: actions/checkout@v3
40+
- name: Setup Ruby
41+
uses: ruby/setup-ruby@v1
42+
with:
43+
ruby-version: '3.1' # Not needed with a .ruby-version file
44+
bundler-cache: true # runs 'bundle install' and caches installed gems automatically
45+
cache-version: 0 # Increment this number if you need to re-download cached gems
46+
working-directory: '${{ github.workspace }}/docs'
47+
- name: Setup Pages
48+
id: pages
49+
uses: actions/configure-pages@v3
50+
- name: Build with Jekyll
51+
# Outputs to the './_site' directory by default
52+
run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
53+
env:
54+
JEKYLL_ENV: production
55+
- name: Upload artifact
56+
# Automatically uploads an artifact from the './_site' directory by default
57+
uses: actions/upload-pages-artifact@v1
58+
with:
59+
path: "docs/_site/"
60+
61+
# Deployment job
62+
deploy:
63+
environment:
64+
name: github-pages
65+
url: ${{ steps.deployment.outputs.page_url }}
66+
runs-on: ubuntu-latest
67+
needs: build
68+
steps:
69+
- name: Deploy to GitHub Pages
70+
id: deployment
71+
uses: actions/deploy-pages@v2

‎build/staging/version/BundleInfo.wxi

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
<Include>
22
<?define SetupVersionName="Developer Preview 5" ?>
3-
<?define SetupVersionNumber="1.0.24037.0313" ?>
3+
<?define SetupVersionNumber="1.0.24038.0027" ?>
44
</Include>

‎docs/Gemfile

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
source 'https://rubygems.org'
2+
3+
gem "jekyll", "~> 4.3.3" # installed by `gem jekyll`
4+
# gem "webrick" # required when using Ruby >= 3 and Jekyll <= 4.2.2
5+
6+
gem "just-the-docs", "0.7.0" # pinned to the current release
7+
# gem "just-the-docs" # always download the latest release
8+
9+
gem "jekyll-default-layout"
10+
gem "jekyll-remote-theme"

‎docs/Gemfile.lock

+100
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
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+
ffi (1.16.3-x64-mingw-ucrt)
14+
forwardable-extended (2.6.0)
15+
google-protobuf (3.25.1-arm64-darwin)
16+
google-protobuf (3.25.1-x64-mingw-ucrt)
17+
google-protobuf (3.25.1-x86_64-linux)
18+
http_parser.rb (0.8.0)
19+
i18n (1.14.1)
20+
concurrent-ruby (~> 1.0)
21+
jekyll (4.3.3)
22+
addressable (~> 2.4)
23+
colorator (~> 1.0)
24+
em-websocket (~> 0.5)
25+
i18n (~> 1.0)
26+
jekyll-sass-converter (>= 2.0, < 4.0)
27+
jekyll-watch (~> 2.0)
28+
kramdown (~> 2.3, >= 2.3.1)
29+
kramdown-parser-gfm (~> 1.0)
30+
liquid (~> 4.0)
31+
mercenary (>= 0.3.6, < 0.5)
32+
pathutil (~> 0.9)
33+
rouge (>= 3.0, < 5.0)
34+
safe_yaml (~> 1.0)
35+
terminal-table (>= 1.8, < 4.0)
36+
webrick (~> 1.7)
37+
jekyll-default-layout (0.1.5)
38+
jekyll (>= 3.0, < 5.0)
39+
jekyll-include-cache (0.2.1)
40+
jekyll (>= 3.7, < 5.0)
41+
jekyll-remote-theme (0.4.3)
42+
addressable (~> 2.0)
43+
jekyll (>= 3.5, < 5.0)
44+
jekyll-sass-converter (>= 1.0, <= 3.0.0, != 2.0.0)
45+
rubyzip (>= 1.3.0, < 3.0)
46+
jekyll-sass-converter (3.0.0)
47+
sass-embedded (~> 1.54)
48+
jekyll-seo-tag (2.8.0)
49+
jekyll (>= 3.8, < 5.0)
50+
jekyll-watch (2.2.1)
51+
listen (~> 3.0)
52+
just-the-docs (0.7.0)
53+
jekyll (>= 3.8.5)
54+
jekyll-include-cache
55+
jekyll-seo-tag (>= 2.0)
56+
rake (>= 12.3.1)
57+
kramdown (2.4.0)
58+
rexml
59+
kramdown-parser-gfm (1.1.0)
60+
kramdown (~> 2.0)
61+
liquid (4.0.4)
62+
listen (3.8.0)
63+
rb-fsevent (~> 0.10, >= 0.10.3)
64+
rb-inotify (~> 0.9, >= 0.9.10)
65+
mercenary (0.4.0)
66+
pathutil (0.16.2)
67+
forwardable-extended (~> 2.6)
68+
public_suffix (5.0.4)
69+
rake (13.0.6)
70+
rb-fsevent (0.11.2)
71+
rb-inotify (0.10.1)
72+
ffi (~> 1.0)
73+
rexml (3.2.6)
74+
rouge (4.2.0)
75+
rubyzip (2.3.2)
76+
safe_yaml (1.0.5)
77+
sass-embedded (1.69.5-arm64-darwin)
78+
google-protobuf (~> 3.23)
79+
sass-embedded (1.69.5-x64-mingw-ucrt)
80+
google-protobuf (~> 3.23)
81+
sass-embedded (1.69.5-x86_64-linux-gnu)
82+
google-protobuf (~> 3.23)
83+
terminal-table (3.0.2)
84+
unicode-display_width (>= 1.1.1, < 3)
85+
unicode-display_width (2.5.0)
86+
webrick (1.8.1)
87+
88+
PLATFORMS
89+
arm64-darwin-23
90+
x64-mingw-ucrt
91+
x86_64-linux
92+
93+
DEPENDENCIES
94+
jekyll (~> 4.3.3)
95+
jekyll-default-layout
96+
jekyll-remote-theme
97+
just-the-docs (= 0.7.0)
98+
99+
BUNDLED WITH
100+
2.3.26

‎docs/_config.yml

+63-3
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,76 @@
11
#site settings
22

3-
title: Windows MIDI Services Documentation
3+
title: Windows MIDI Services
44
description: User and developer documentation for the Windows MIDI Services project
5-
#show_downloads: true
5+
baseurl: "/docs"
66
twitter_username: pete_brown
77
github_username: psychlist1972
88

99
#theme
10-
remote_theme: pages-themes/[email protected]
10+
#remote_theme: pages-themes/[email protected]
11+
theme: just-the-docs
12+
13+
14+
exclude:
15+
# from https://github.com/jekyll/jekyll/blob/master/lib/site_template/_config.yml:
16+
- .sass-cache/
17+
- .jekyll-cache/
18+
- gemfiles/
19+
- Gemfile
20+
- Gemfile.lock
21+
- node_modules/
22+
- vendor/bundle/
23+
- vendor/cache/
24+
- vendor/gems/
25+
- vendor/ruby/
26+
27+
28+
# Enable or disable the site search
29+
# Supports true (default) or false
30+
search_enabled: true
31+
search:
32+
# Split pages into sections that can be searched individually
33+
# Supports 1 - 6, default: 2
34+
heading_level: 2
35+
# Maximum amount of previews per search result
36+
# Default: 3
37+
previews: 2
38+
# Maximum amount of words to display before a matched word in the preview
39+
# Default: 5
40+
preview_words_before: 3
41+
# Maximum amount of words to display after a matched word in the preview
42+
# Default: 10
43+
preview_words_after: 3
44+
# Set the search token separator
45+
# Default: /[\s\-/]+/
46+
# Example: enable support for hyphenated search words
47+
tokenizer_separator: /[\s/]+/
48+
# Display the relative url in search results
49+
# Supports true (default) or false
50+
rel_url: true
51+
# Enable or disable the search button that appears in the bottom right corner of every page
52+
# Supports true or false (default)
53+
button: false
54+
55+
56+
# For copy button on code
57+
enable_copy_code_button: true
58+
59+
# Enable or disable heading anchors
60+
heading_anchors: true
61+
62+
# Back to top link
63+
back_to_top: true
64+
back_to_top_text: "Back to top"
65+
1166

1267
#plugins
1368

1469
plugins:
1570
- jekyll-remote-theme
71+
- jekyll-default-layout
1672

73+
kramdown:
74+
syntax_highlighter_opts:
75+
block:
76+
line_numbers: false

‎docs/_includes/components/breadcrumbs.html

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
{%- comment -%}
2+
Include as: {%- include components/breadcrumbs.html -%}
3+
Depends on: page, site.
4+
Results in: HTML for the breadcrumbs component.
5+
Overwrites:
6+
node, pages_list, parent_page, grandparent_page.
7+
{%- endcomment -%}
8+
9+
{%- if page.url != "/" and page.parent -%}
10+
11+
{%- assign pages_list = site[page.collection] | default: site.html_pages -%}
12+
13+
{%- assign parent_page = nil -%}
14+
{%- assign grandparent_page = nil -%}
15+
16+
{%- for node in pages_list -%}
17+
18+
{%- if node.has_children and page.grand_parent -%}
19+
20+
{%- if node.title == page.parent and node.parent == page.grand_parent -%}
21+
{%- assign parent_page = node -%}
22+
{%- endif -%}
23+
{%- if node.title == page.grand_parent -%}
24+
{%- assign grandparent_page = node -%}
25+
{%- endif -%}
26+
{%- if parent_page and grandparent_page -%}
27+
{%- break -%}
28+
{%- endif -%}
29+
30+
{%- elsif node.has_children and node.title == page.parent and node.parent == nil -%}
31+
32+
{%- assign parent_page = node -%}
33+
{%- break -%}
34+
35+
{%- endif -%}
36+
37+
{%- endfor -%}
38+
39+
<nav aria-label="Breadcrumb" class="breadcrumb-nav">
40+
<ol class="breadcrumb-nav-list">
41+
{% if page.parent -%}
42+
{%- if page.grand_parent %}
43+
<li class="breadcrumb-nav-list-item"><a href="{{ grandparent_page.url | relative_url }}">{{ page.grand_parent }}</a></li>
44+
{%- endif %}
45+
<li class="breadcrumb-nav-list-item"><a href="{{ parent_page.url | relative_url }}">{{ page.parent }}</a></li>
46+
{% endif -%}
47+
<li class="breadcrumb-nav-list-item"><span>{{ page.title }}</span></li>
48+
</ol>
49+
</nav>
50+
51+
{%- endif -%}

‎docs/_includes/components/nav.html

+75
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
{%- comment -%}
2+
Include as: {%- include components/nav.html pages=pages -%}
3+
Depends on: include.pages.
4+
Results in: HTML for the navigation panel.
5+
Includes:
6+
sorted_pages.html
7+
Overwrites:
8+
nav_pages, first_level_pages, second_level_pages, third_level_pages,
9+
node, children_list, child, grand_children_list, grand_child.
10+
{%- endcomment -%}
11+
12+
{%- assign nav_pages = include.pages
13+
| where_exp: "item", "item.title != nil"
14+
| where_exp: "item", "item.nav_exclude != true" -%}
15+
16+
{%- include sorted_pages.html pages = nav_pages -%}
17+
18+
{%- comment -%}
19+
It might be more efficient to sort the pages at each level separately.
20+
{%- endcomment -%}
21+
22+
{%- assign first_level_pages = sorted_pages
23+
| where_exp: "item", "item.parent == nil" -%}
24+
{%- assign second_level_pages = sorted_pages
25+
| where_exp: "item", "item.parent != nil"
26+
| where_exp: "item", "item.grand_parent == nil" -%}
27+
{%- assign third_level_pages = sorted_pages
28+
| where_exp: "item", "item.grand_parent != nil" -%}
29+
30+
<ul class="nav-list">
31+
{%- for node in first_level_pages -%}
32+
<li class="nav-list-item">
33+
{%- if node.has_children -%}
34+
<button class="nav-list-expander btn-reset" aria-label="toggle items in {{ node.title }} category" aria-pressed="false">
35+
<svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
36+
</button>
37+
{%- endif -%}
38+
<a href="{{ node.url | relative_url }}" class="nav-list-link">{{ node.title }}</a>
39+
{%- if node.has_children -%}
40+
{%- assign children_list = second_level_pages
41+
| where: "parent", node.title -%}
42+
{%- if node.child_nav_order == 'desc' or node.child_nav_order == 'reversed' -%}
43+
{%- assign children_list = children_list | reverse -%}
44+
{%- endif -%}
45+
<ul class="nav-list">
46+
{%- for child in children_list -%}
47+
<li class="nav-list-item">
48+
{%- if child.has_children -%}
49+
<button class="nav-list-expander btn-reset" aria-label="toggle items in {{ child.title }} category" aria-pressed="false">
50+
<svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
51+
</button>
52+
{%- endif -%}
53+
<a href="{{ child.url | relative_url }}" class="nav-list-link">{{ child.title }}</a>
54+
{%- if child.has_children -%}
55+
{%- assign grand_children_list = third_level_pages
56+
| where: "parent", child.title
57+
| where: "grand_parent", node.title -%}
58+
{%- if child.child_nav_order == 'desc' or child.child_nav_order == 'reversed' -%}
59+
{%- assign grand_children_list = grand_children_list | reverse -%}
60+
{%- endif -%}
61+
<ul class="nav-list">
62+
{%- for grand_child in grand_children_list -%}
63+
<li class="nav-list-item">
64+
<a href="{{ grand_child.url | relative_url }}" class="nav-list-link">{{ grand_child.title }}</a>
65+
</li>
66+
{%- endfor -%}
67+
</ul>
68+
{%- endif -%}
69+
</li>
70+
{%- endfor -%}
71+
</ul>
72+
{%- endif -%}
73+
</li>
74+
{%- endfor -%}
75+
</ul>

0 commit comments

Comments
 (0)