Skip to content

Commit 465874f

Browse files
Merge branch 'main' into feat/example-sveltekit
2 parents 6ce57d9 + 0ab1cdd commit 465874f

40 files changed

+659
-174
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,26 @@ deno task reference
6565
This will generate the reference docs, and you can use the `serve` or `build`
6666
tasks.
6767

68+
The API reference documentation is generated from type definitions in the
69+
[Deno source code](https://github.com/denoland/deno). The API reference content
70+
can be edited by modifying the JSDoc comments in the corresponding `d.ts` files
71+
in the Deno source code. Once merged, the changes will be reflected in the API
72+
reference documentation when the Deno documentation site is next updated.
73+
74+
### Previewing API reference changes
75+
76+
In order to preview changes to the API reference, take the following steps:
77+
78+
1. Make changes to the JSDoc comments in the Deno source code
79+
1. [Build the Deno CLI locally](https://docs.deno.com/runtime/contributing/building_from_source/),
80+
including your JSDoc changes
81+
1. For convenience, create an alias of `d_deno` to point to your local build of
82+
the Deno CLI (typically in the `target/debug/deno` directory of your CLI
83+
repo)
84+
1. Generate the reference docs from your local build of the Deno CLI by running
85+
in the root directory `d_deno task reference`
86+
1. Run the `deno task serve` command in the root directory to see the changes
87+
6888
## Versioning docs content
6989

7090
Philosophically, we want to maintain as few discrete versions of the

_components/Footer.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ const data = [
8888
items: [
8989
{
9090
label: "Blog",
91-
href: "https://www.deno.com/blog",
91+
href: "https://deno.com/blog",
9292
},
9393
{
9494
label: "Careers",

_components/Header.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ export default function Header({
4545
url={url}
4646
activeOn="/runtime"
4747
href="/runtime/"
48-
name="Runtime Manual"
48+
name="Manual"
4949
hideOnMobile
5050
/>
5151
<HeaderItem

_components/Sidebar.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ export default function Sidebar(
2222
>
2323
<ul className="xl:hidden border-bg-tertiary relative bg-background-secondary m-2 mt-0 mb-4 py-2 rounded-md border border-background-tertiary">
2424
<SidebarTopNav
25-
name="Runtime"
25+
name="Manual"
2626
url="/runtime/"
2727
currentPath={props.url}
2828
/>

copy.client.ts

Lines changed: 29 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,31 @@
1-
const copyBtns = document.querySelectorAll("button[data-copy]");
2-
3-
copyBtns.forEach((btn) => {
4-
btn.addEventListener("click", () => {
5-
let textToCopy = btn.getAttribute("data-copy") as string;
6-
// CLEAN COMMANDS: Remove leading spaces, $, and > from each line
7-
textToCopy = textToCopy.replace(/^[\$>\s]+/, "");
8-
navigator?.clipboard?.writeText(textToCopy);
1+
document.addEventListener("click", (event) => {
2+
const btn = (event.target as HTMLElement).closest("button[data-copy]");
3+
4+
if (!btn) {
5+
return;
6+
}
7+
8+
let textToCopy = btn.getAttribute("data-copy") as string;
9+
10+
// CLEAN COMMANDS: Remove leading spaces, $, and > from each line
11+
textToCopy = textToCopy.replace(/^[\$>\s]+/, "");
12+
13+
navigator?.clipboard?.writeText(textToCopy).then(() => {
14+
if (!btn) {
15+
return;
16+
}
17+
18+
const copyIcon = btn.querySelector(".copy-icon");
19+
const checkIcon = btn.querySelector(".check-icon");
20+
21+
if (copyIcon && checkIcon) {
22+
copyIcon.classList.add("hidden");
23+
checkIcon.classList.remove("hidden");
24+
25+
setTimeout(() => {
26+
copyIcon.classList.remove("hidden");
27+
checkIcon.classList.add("hidden");
28+
}, 2000);
29+
}
930
});
1031
});

deno.lock

Lines changed: 4 additions & 80 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

deploy/kv/manual/cron.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -91,9 +91,9 @@ different compared to other cron engines which use 0-6 representation.
9191

9292
## Usage on Deno Deploy
9393

94-
With [Deno Deploy](https://www.deno.com/deploy), you can run your background
95-
tasks on V8 isolates in the cloud. When doing so, there are a few considerations
96-
to keep in mind.
94+
With [Deno Deploy](https://deno.com/deploy), you can run your background tasks
95+
on V8 isolates in the cloud. When doing so, there are a few considerations to
96+
keep in mind.
9797

9898
### Differences with Deno CLI
9999

deploy/kv/tutorials/schedule_notification.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ A common use case for [queues](../manual/queue_overview.md) is scheduling work
88
to be completed at some point in the future. To help demonstrate how this works,
99
we've provided a sample application (described below) that schedules
1010
notification messages sent through the [Courier API](https://www.courier.com/).
11-
The application runs on [Deno Deploy](https://www.deno.com/deploy), using the
11+
The application runs on [Deno Deploy](https://deno.com/deploy), using the
1212
built-in KV and queue API implementations available there with zero
1313
configuration.
1414

deploy/manual/ci_github.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ for **Automatic** and **GitHub Actions** mode.
2626
## Automatic
2727

2828
If your project doesn't require any additional build steps, then the system
29-
choose **Automatic** mode. The entrypoint file is simply the file that Deno
29+
chooses **Automatic** mode. The entrypoint file is simply the file that Deno
3030
Deploy will run.
3131

3232
## GitHub Actions

deploy/manual/pricing-and-limits.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
title: "Pricing and limitations"
33
---
44

5-
Please see [our pricing page](https://www.deno.com/deploy/pricing) for the
6-
overview of the available features in all plans. If you have a use case that
7-
exceeds any of these limits, [please reach out](mailto:deploy@deno.com).
5+
Please see [our pricing page](https://deno.com/deploy/pricing) for the overview
6+
of the available features in all plans. If you have a use case that exceeds any
7+
of these limits, [please reach out](mailto:deploy@deno.com).
88

99
No uptime guarantees are provided during the initial public beta for Deno
1010
Deploy. Access to the service will be controlled by

0 commit comments

Comments
 (0)