Unverified Commit 8ca0fa1c authored by Hong Minhee (洪 民憙)'s avatar Hong Minhee (洪 民憙) Committed by GitHub
Browse files

Merge pull request #292 from w8385/update/docs-readme-289

[ci skip]
parents df614539 8daaea6d
Loading
Loading
Loading
Loading
+6 −5
Original line number Diff line number Diff line
@@ -4,17 +4,18 @@ 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 [Bun]
In order to build the docs locally, you need to install [Node.js] and [pnpm]
first. Then you can run the following commands (assuming you are in
the *docs/* directory):

~~~~ bash
bun install
bun run dev
pnpm install
pnpm 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/
[Bun]: https://bun.sh/
[Node.js]: https://nodejs.org/
[pnpm]: https://pnpm.io/