Skip to content

Commit

Permalink
docs: Return back to Bun
Browse files Browse the repository at this point in the history
[ci skip]
  • Loading branch information
dahlia committed Nov 29, 2024
1 parent bda6d57 commit 7c08b9f
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 5,088 deletions.
15 changes: 8 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,9 @@ For Markdown, we have the following conventions:
- Two new lines before opening an H1/H2 heading.
- One space before and two spaces after a bullet.
- Wrap file paths in asterisks.
- Wrap code in backticks.
- Wrap inline code in backticks.
- Wrap code blocks in quadruple tildes (`~~~~`), and specify the language with
a single space after the opening tildes (e.g., `~~~~ bash`).

In order to build the docs,
see the [*Building the docs* section](#building-the-docs).
Expand Down Expand Up @@ -159,9 +161,10 @@ install Deno to hack on Fedify.

> [!TIP]
> If you use [mise-en-place], a dev tools/env vars manager and a task runner,
> you can easily install Deno, [Node.js], and [Bun] with a single command:
> you can easily install Deno, [Node.js], and [Bun] with following commands:
>
> ~~~~ bash
> mise trust
> mise install
> ~~~~
Expand Down Expand Up @@ -258,15 +261,13 @@ with Node.js and Bun.
### Building the docs
If you want to change the Fedify docs, you would like to preview the changes
in the browser. To do that, you need to install Node.js and [pnpm] first.
in the browser. To do that, you need to install [Bun] first.
Then you can run the following commands at the *docs/* directory:
~~~~ bash
pnpm install
pnpm dev
bun install
bun dev
~~~~
Once the development server is running, you can open your browser and navigate
to *http://localhost:5173/* to view the docs.

[pnpm]: https://pnpm.io/
1 change: 1 addition & 0 deletions cli/import_map.g.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
"@fedify/fedify/x/denokv": "../src/./x/denokv.ts",
"@fedify/fedify/x/fresh": "../src/./x/fresh.ts",
"@fedify/fedify/x/hono": "../src/./x/hono.ts",
"@fedify/fedify/x/sveltekit": "../src/./x/sveltekit.ts",
"@hongminhee/aitertools": "jsr:@hongminhee/aitertools@^0.6.0",
"@hugoalh/http-header-link": "jsr:@hugoalh/http-header-link@^1.0.2",
"@logtape/logtape": "jsr:@logtape/logtape@^0.8.0",
Expand Down
9 changes: 4 additions & 5 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,17 @@ Fedify docs
This directory contains the source files of the Fedify docs. The docs are
written in Markdown format and are built with [VitePress].

In order to build the docs locally, you need to install [Node.js] and [pnpm]
In order to build the docs locally, you need to install [Bun]
first. Then you can run the following commands (assuming you are in
the *docs/* directory):

~~~~ bash
pnpm install
pnpm run dev
bun install
bun run dev
~~~~

Once the development server is running, you can open your browser and navigate
to *http://localhost:5173/* to view the docs.

[VitePress]: https://vitepress.dev/
[Node.js]: https://nodejs.org/
[pnpm]: https://pnpm.io/
[Bun]: https://bun.sh/
Binary file added docs/bun.lockb
Binary file not shown.
13 changes: 5 additions & 8 deletions docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@
"@hono/node-server": "^1.12.2",
"@js-temporal/polyfill": "^0.4.4",
"@logtape/logtape": "^0.8.0",
"@opentelemetry/exporter-trace-otlp-proto": "^0.55.0",
"@opentelemetry/sdk-node": "^0.55.0",
"@sentry/node": "^8.40.0",
"@shikijs/vitepress-twoslash": "^1.17.6",
"@teidesu/deno-types": "^1.46.3",
"@types/amqplib": "^0.10.5",
Expand All @@ -25,19 +28,13 @@
"mermaid": "^10.9.1",
"postgres": "^3.4.5",
"stringify-entities": "^4.0.4",
"vitepress": "^1.3.1",
"vitepress-plugin-mermaid": "^2.0.16",
"vitepress": "^1.5.0",
"vitepress-plugin-mermaid": "^2.0.17",
"x-forwarded-fetch": "^0.2.0"
},
"scripts": {
"dev": "vitepress dev",
"build": "vitepress build",
"preview": "vitepress preview"
},
"packageManager": "[email protected]+sha512.140036830124618d624a2187b50d04289d5a087f326c9edfc0ccd733d76c4f52c3a313d4fc148794a2a9d81553016004e6742e8cf850670268a7387fc220c903",
"dependencies": {
"@opentelemetry/exporter-trace-otlp-proto": "^0.55.0",
"@opentelemetry/sdk-node": "^0.55.0",
"@sentry/node": "^8.40.0"
}
}
Loading

0 comments on commit 7c08b9f

Please sign in to comment.