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

Replace the TOC menu in Docs, add a menu to Tutorials #12822

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft
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
43 changes: 37 additions & 6 deletions assets/css/bundle.css
Original file line number Diff line number Diff line change
Expand Up @@ -3850,9 +3850,7 @@ div.highlight .copy-button{
flex-basis:32px;
overflow-y:auto;
height:calc(100vh - 38px);
position:sticky;
left:0;
top:0
left:0
}

.docs-list-main .docs-main-nav-toggle-wrapper .docs-main-nav nav.main-nav div:first-of-type{
Expand Down Expand Up @@ -4434,6 +4432,10 @@ div.highlight .copy-button{
display:flex
}

.docs-list-main div#accordion-table-of-contents input:checked~div.accordion-content .icon,.docs-list-main div#accordion-table-of-contents input:checked~label.hide .icon,body.section-registry div#accordion-table-of-contents input:checked~div.accordion-content .icon,body.section-registry div#accordion-table-of-contents input:checked~label.hide .icon{
rotate:180deg
}

.docs-list-main div#accordion-table-of-contents .heading:hover div.icon,body.section-registry div#accordion-table-of-contents .heading:hover div.icon{
background-color:#2b2b2c
}
Expand Down Expand Up @@ -22523,6 +22525,35 @@ pulumi-convert #editors .editor .diagnostics .details{
padding-left:0 !important
}

pulumi-docs-toc{
position: sticky;
top: 0px
}

pulumi-docs-toc ul li.toc-level-h3{
margin-left: 1rem
}

pulumi-docs-toc ul li a{
--tw-text-opacity: 1;
color: rgba(47, 48, 50, var(--tw-text-opacity))
}

pulumi-docs-toc ul li a:hover{
--tw-text-opacity: 1;
color: rgba(46, 55, 130, var(--tw-text-opacity));
text-decoration:none !important
}

pulumi-docs-toc ul li.active a{
--tw-text-opacity: 1;
color: rgba(46, 55, 130, var(--tw-text-opacity))
}

pulumi-docs-toc ul :nth-child(1 of li.active){
font-weight: 600
}

pulumi-filter-select pulumi-filter-select-option-group{
font-family: Gilroy, ui-sans-serif, system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, "Noto Sans", sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji";
font-size: 1rem;
Expand Down Expand Up @@ -23430,8 +23461,8 @@ main blockquote p{
:target::before{
content:" ";
display:block;
height:106px;
margin-top:-106px
height:74px;
margin-top:-74px
}
}

Expand All @@ -23441,7 +23472,7 @@ main blockquote p{
align-self: flex-start;
overflow-y: auto;
max-height:90vh;
top:106px
top:74px
}

.section-registry .sticky-sidebar{
Expand Down
3 changes: 0 additions & 3 deletions assets/css/marketing.css
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
/*!*********************************************************************************************************************************************************************************************************************!*\
!*** css ./node_modules/css-loader/dist/cjs.js??ruleSet[1].rules[1].use[1]!./node_modules/postcss-loader/dist/cjs.js!./node_modules/sass-loader/dist/cjs.js??ruleSet[1].rules[1].use[3]!./src/scss/_marketing.scss ***!
\*********************************************************************************************************************************************************************************************************************/
/*! tailwindcss v2.2.15 | MIT License | https://tailwindcss.com */

/*! modern-normalize v1.1.0 | MIT License | https://github.com/sindresorhus/modern-normalize */
Expand Down
67 changes: 66 additions & 1 deletion assets/js/bundle.js

Large diffs are not rendered by default.

1 change: 0 additions & 1 deletion assets/js/marketing.js
Original file line number Diff line number Diff line change
@@ -1 +0,0 @@
(()=>{"use strict";var __webpack_modules__={"./src/scss/_marketing.scss":(__unused_webpack_module,__webpack_exports__,__webpack_require__)=>{eval("__webpack_require__.r(__webpack_exports__);\n// extracted by mini-css-extract-plugin\n\n\n//# sourceURL=webpack://theme/./src/scss/_marketing.scss?")},"./src/ts/marketing.ts":(__unused_webpack_module,__webpack_exports__,__webpack_require__)=>{eval('__webpack_require__.r(__webpack_exports__);\n/* harmony import */ var _scss_marketing_scss__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../scss/_marketing.scss */ "./src/scss/_marketing.scss");\n\n\n\n//# sourceURL=webpack://theme/./src/ts/marketing.ts?')}},__webpack_module_cache__={};function __webpack_require__(_){var e=__webpack_module_cache__[_];if(void 0!==e)return e.exports;var r=__webpack_module_cache__[_]={exports:{}};return __webpack_modules__[_](r,r.exports,__webpack_require__),r.exports}__webpack_require__.r=_=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(_,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(_,"__esModule",{value:!0})};var __webpack_exports__=__webpack_require__("./src/ts/marketing.ts")})();
8 changes: 4 additions & 4 deletions content/docs/iac/get-started/aws/begin.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ aliases:

Before you get started using Pulumi, let's run through a few quick steps to ensure your environment is set up correctly.

### Install Pulumi
## Install Pulumi

{{< install-pulumi >}}
{{% notes "info" %}}
Expand All @@ -28,9 +28,9 @@ All Windows examples in this tutorial assume you are running in PowerShell.

Next, install the required language runtime, if you have not already.

### Install Language Runtime
## Install Language Runtime

#### Choose Your Language
### Choose Your Language

{{< chooser language "javascript,typescript,python,go,csharp,java,yaml" / >}}

Expand Down Expand Up @@ -58,7 +58,7 @@ Next, install the required language runtime, if you have not already.
{{< install-yaml >}}
{{% /choosable %}}

### Configure Pulumi to access your AWS account
## Configure Pulumi to access your AWS account

Pulumi requires cloud credentials to manage and provision resources. You must use an IAM user account that has **programmatic access** with rights to deploy and manage resources handled through Pulumi.

Expand Down
8 changes: 4 additions & 4 deletions content/docs/iac/get-started/azure/begin.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ aliases:

Before you get started using Pulumi, let's run through a few quick steps to ensure your environment is set up correctly.

### Install Pulumi
## Install Pulumi

{{< install-pulumi >}}
{{% notes "info" %}}
Expand All @@ -28,9 +28,9 @@ All Windows examples in this tutorial assume you are running in PowerShell.

Next, install the required language runtime, if you have not already.

### Install Language Runtime
## Install Language Runtime

#### Choose Your Language
### Choose Your Language

{{< chooser language "typescript,python,go,csharp,java,yaml" / >}}

Expand Down Expand Up @@ -60,7 +60,7 @@ Next, install the required language runtime, if you have not already.

Finally, configure Pulumi with Microsoft Azure.

### Configure Pulumi to access your Microsoft Azure account
## Configure Pulumi to access your Microsoft Azure account

Pulumi requires cloud credentials to manage and provision resources. Pulumi can authenticate to Azure using a user account or service principal that has **Programmatic access** with rights to deploy and manage your Azure resources.

Expand Down
8 changes: 4 additions & 4 deletions content/docs/iac/get-started/gcp/begin.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ aliases:

Before you get started using Pulumi, let's run through a few quick steps to ensure your environment is set up correctly.

### Install Pulumi
## Install Pulumi

{{< install-pulumi >}}
{{% notes "info" %}}
Expand All @@ -28,9 +28,9 @@ All Windows examples in this tutorial assume you are running in PowerShell.

Next, install the required language runtime, if you have not already.

### Install Language Runtime
## Install Language Runtime

#### Choose Your Language
### Choose Your Language

{{< chooser language "javascript,typescript,python,go,csharp,java,yaml" / >}}

Expand Down Expand Up @@ -60,7 +60,7 @@ Next, install the required language runtime, if you have not already.

Finally, configure Pulumi with Google Cloud.

### Configure Pulumi to access your Google Cloud account
## Configure Pulumi to access your Google Cloud account

Pulumi requires cloud credentials to manage and provision resources. You must use an IAM user or service account that has **Programmatic access** with rights to deploy and manage your Google Cloud resources.

Expand Down
6 changes: 3 additions & 3 deletions layouts/docs/list.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{{ if not .Params.noleftnav }}
<div class="docs-main-nav-toggle-wrapper">
<div class="docs-main-nav-wrapper">
<div id="docs-main-nav" class="docs-main-nav">
<div id="docs-main-nav" class="docs-main-nav sticky top-10">
{{ partial "docs/menu.html" (dict "page" .) }}
</div>
</div>
Expand Down Expand Up @@ -44,8 +44,8 @@ <h1>{{ .Title }}</h1>
</section>
</div>
{{ if not .Params.norightnav }}
<div class="docs-table-of-contents docs-toc-desktop">
{{ partial "docs/table-of-contents.html" . }}
<div class="docs-toc mx-4 sticky top-10 h-full">
{{ partial "docs/toc.html" . }}

{{ partial "docs/feedback.html" . }}

Expand Down
6 changes: 3 additions & 3 deletions layouts/docs/single.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<div class="docs-list-main">
<div class="docs-main-nav-toggle-wrapper">
<div class="docs-main-nav-wrapper">
<div id="docs-main-nav" class="docs-main-nav">
<div id="docs-main-nav" class="docs-main-nav sticky top-10">
{{ partial "docs/menu.html" (dict "page" .) }}
</div>
</div>
Expand Down Expand Up @@ -42,8 +42,8 @@ <h1>{{ .Title }}</h1>
</section>
</div>

<div class="docs-table-of-contents docs-toc-desktop">
{{ partial "docs/table-of-contents.html" . }}
<div class="docs-toc mx-4 sticky top-10 h-full">
{{ partial "docs/toc.html" . }}

{{ partial "docs/feedback.html" . }}

Expand Down
4 changes: 2 additions & 2 deletions layouts/partials/docs/feedback.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<div id="docsFeedbackContainer" class="hidden mt-4 border-t border-gray-300 pl-2 text-xs text-gray-600">
<div id="feedbackButtons">
<div id="docsFeedbackContainer" class="hidden mt-8 border-t border-gray-200 pl-2 text-xs text-gray-600">
<div id="feedbackButtons" class="my-8">
<p class="my-4">Was this page helpful?</p>
<div class="flex items-center">
<a id="docsFeedbackYes" data-track="feedback-yes" class="flex items-center cursor-pointer hover:text-gray-700">
Expand Down
19 changes: 1 addition & 18 deletions layouts/partials/docs/table-of-contents.html
Original file line number Diff line number Diff line change
Expand Up @@ -26,24 +26,7 @@ <h2 class="no-anchor">On this page</h2>
</label>
<div class="accordion-content flex">
<div class="content">
<ul class="table-of-contents-list">
{{/* This will be populated dynamically with all H2s and H3s on the page; see ts/misc.ts */}}
</ul>
{{ if strings.Contains $.Page.Permalink "registry/packages" }}
{{ $path := (split .Page.Params.title_tag ".") }}
{{- if eq (len $path) 3 -}}
{{ $packageName := index $path 0 }}
{{ $moduleName := index $path 1 }}
{{ $resourceName := index $path 2 }}
<div class="mt-6">
<pulumi-resource-links
package-name="{{ $packageName }}"
module-name="{{ $moduleName }}"
resource-name="{{ $resourceName }}"
></pulumi-resource-links>
</div>
{{ end }}
{{ end }}
<pulumi-docs-toc></pulumi-docs-toc>
</div>
</div>
</div>
Expand Down
6 changes: 6 additions & 0 deletions layouts/partials/docs/toc.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<div class="hidden lg:block">
<div class="mt-8 mb-4 py-0">
<span class="text-xs font-bold text-gray-700">On this page</span>
</div>
<pulumi-docs-toc></pulumi-docs-toc>
</div>
4 changes: 2 additions & 2 deletions layouts/partials/tutorials/feedback.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<div id="docsFeedbackContainer" class="hidden pl-2 text-xs text-gray-600">
<div id="feedbackButtons">
<div id="docsFeedbackContainer" class="hidden mt-8 border-t border-gray-200 text-xs text-gray-600">
<div id="feedbackButtons" class="my-8">
<p class="my-4">Was this page helpful?</p>
<div class="flex items-center">
<a id="docsFeedbackYes" data-track="feedback-yes" class="flex items-center cursor-pointer hover:text-gray-700">
Expand Down
6 changes: 6 additions & 0 deletions layouts/partials/tutorials/toc.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<div class="hidden lg:block">
<div class="mt-8 mb-4 py-0">
<span class="text-xs font-bold text-gray-700">On this page</span>
</div>
<pulumi-docs-toc></pulumi-docs-toc>
</div>
3 changes: 2 additions & 1 deletion layouts/tutorials/module.html
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,8 @@ <h2>Topics</h2>
</div>
</div>
</div>
<div class="sticky top-10 pt-8 max-h-75 xl:w-2/12 hidden xl:block">
<div class="sticky top-12 max-h-75 xl:w-2/12 hidden xl:block xl:pr-4">
{{ partial "tutorials/toc.html" }}
{{ partial "tutorials/feedback.html" . }}
{{ partial "tutorials/right-nav-ad.html" }}
</div>
Expand Down
3 changes: 2 additions & 1 deletion layouts/tutorials/single.html
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,8 @@ <h2 class="mb-4">Prerequisites:</h2>
</div>
</div>
</div>
<div class="sticky top-10 pt-8 max-h-75 xl:w-2/12 hidden xl:block">
<div class="sticky top-12 max-h-75 xl:w-2/12 hidden xl:block xl:pr-4">
{{ partial "tutorials/toc.html" }}
{{ partial "tutorials/feedback.html" . }}
{{ partial "tutorials/right-nav-ad.html" }}
</div>
Expand Down
3 changes: 2 additions & 1 deletion layouts/tutorials/topic.html
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ <h1>{{ .Title }}</h1>
</div>
</div>
</div>
<div class="sticky top-10 pt-8 max-h-75 xl:w-2/12 hidden xl:block">
<div class="sticky top-12 max-h-75 xl:w-2/12 hidden xl:block xl:pr-4">
{{ partial "tutorials/toc.html" }}
{{ partial "tutorials/feedback.html" . }}
{{ partial "tutorials/right-nav-ad.html" }}
</div>
Expand Down
32 changes: 32 additions & 0 deletions theme/src/scss/components/_docs-toc.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
pulumi-docs-toc {
@apply sticky top-0;

ul {
li {
&.toc-level-h3 {
@apply ml-4;
}

a {
@apply text-gray-800;

&:hover {
@apply text-blue-800;
text-decoration: none !important;
}
}

&.active {
a {
@apply text-blue-800;
}
}
}

// Select the first item in the list. (There will often be multiple --
// e.g., when more than one heading is visible on the page.
:nth-child(1 of li.active) {
@apply font-semibold;
}
}
}
6 changes: 4 additions & 2 deletions theme/src/scss/docs/_docs-main.scss
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,7 @@ body.section-registry {
flex-basis: 32px;
overflow-y: auto;
height: calc(100vh - 38px);
position: sticky;
left: 0;
top: 0;

nav.main-nav div:first-of-type {
margin-top: 0;
Expand Down Expand Up @@ -730,6 +728,10 @@ body.section-registry {
input:checked ~ label.hide {
margin-bottom: 24px;
display: flex;

.icon {
rotate: 180deg;
}
}

.heading:hover {
Expand Down
3 changes: 2 additions & 1 deletion theme/src/scss/main.scss
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@
@import "components/choosable";
@import "components/convert";
@import "components/docs-nav";
@import "components/docs-toc";
@import "components/filter-select";
@import "components/greenhouse-jobs-list";
@import "components/install";
Expand Down Expand Up @@ -271,7 +272,7 @@ main {
}
}

$sitenav-height: 90px;
$sitenav-height: 58px;

// A 16px offset makes it easier to position elements below the nav when it's pinned.
$sitenav-offset: calc($sitenav-height + 16px);
Expand Down
Loading
Loading