Loading docs/README.md 0 → 100644 +19 −0 Original line number Diff line number Diff line 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] first. Then you can run the following commands (assuming you are in the *docs/* directory): ~~~~ bash 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. [VitePress]: https://vitepress.dev/ [Bun]: https://bun.sh/ docs/contribute.md +16 −3 Original line number Diff line number Diff line Loading @@ -80,10 +80,23 @@ For Markdown, we have the following conventions: - Wrap file paths in asterisks. - Wrap code in backticks. In order to build the docs, as a prerequisite, you need to install [Bun] first. Then you can run the following commands: ~~~~ bash cd docs/ 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. [reference links]: https://spec.commonmark.org/0.31.2/#shortcut-reference-link [inline links]: https://spec.commonmark.org/0.31.2/#inline-link [setext headings]: https://spec.commonmark.org/0.31.2/#setext-headings [ATX headings]: https://spec.commonmark.org/0.31.2/#atx-headings [Bun]: https://bun.sh/ ### Bug fix Loading Loading
docs/README.md 0 → 100644 +19 −0 Original line number Diff line number Diff line 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] first. Then you can run the following commands (assuming you are in the *docs/* directory): ~~~~ bash 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. [VitePress]: https://vitepress.dev/ [Bun]: https://bun.sh/
docs/contribute.md +16 −3 Original line number Diff line number Diff line Loading @@ -80,10 +80,23 @@ For Markdown, we have the following conventions: - Wrap file paths in asterisks. - Wrap code in backticks. In order to build the docs, as a prerequisite, you need to install [Bun] first. Then you can run the following commands: ~~~~ bash cd docs/ 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. [reference links]: https://spec.commonmark.org/0.31.2/#shortcut-reference-link [inline links]: https://spec.commonmark.org/0.31.2/#inline-link [setext headings]: https://spec.commonmark.org/0.31.2/#setext-headings [ATX headings]: https://spec.commonmark.org/0.31.2/#atx-headings [Bun]: https://bun.sh/ ### Bug fix Loading
