Skip to content

edit docs #782

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.

Sign up for GitHub

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

Merged
hatemhosny merged 2 commits into from
Apr 8, 2025
Merged

edit docs #782

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
36ae9e3
docs: use remark-plugin-npm2yarn
hatemhosny Apr 8, 2025
a1f9011
edit docs
hatemhosny Apr 8, 2025
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
4 changes: 2 additions & 2 deletions docs/docs/getting-started.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ LiveCodes [<abbr title="Software Development Kit">SDK</abbr>](./sdk/index.mdx) i

Install from npm.

```shell
npm i livecodes
```bash npm2yarn
npm install livecodes
```

then you can use it like that:
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/languages/vue.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -408,7 +408,7 @@ Using [Prettier](https://prettier.io/).
Currently, Vue support has the following limitations:

- SSR is not supported.
- The [`defineProps()`](https://vuejs.org/guide/components/props#props-declaration) macro cannot infer props from TypeScript types. Props have to be explicitly declared.
- The [`defineProps()`](https://vuejs.org/guide/components/props#props-declaration) macro cannot infer props from TypeScript types not defined in the same file.

[PRs are welcome](https://github.com/live-codes/livecodes/issues/757).

Expand Down
6 changes: 3 additions & 3 deletions docs/docs/sdk/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ This is an example of an editable embedded playground using the SDK.
This is a single npm package for the SDK which supports JavaScript/TypeScript, React, Vue and Svelte.
Install the library from npm:

```sh
npm i livecodes
```bash npm2yarn
npm install livecodes
```

then it can be used like that:
Expand Down Expand Up @@ -116,6 +116,6 @@ A demo page that shows the usage of the SDK can be [found here](https://live-cod

Or edit the SDK playground in LiveCodes. How meta! :)

<LiveCodes import="id/nqdxpnj6uvg" view="result" height="80vh" showCode={false} />
<LiveCodes import="id/8k6vbxitvb9" config={{ view: 'result' }} height="80vh" showCode={false} />

P.S. You may want to use the "Full Screen" button!
7 changes: 7 additions & 0 deletions docs/docusaurus.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,12 @@ const config: Config = {
const sidebarItems = await defaultSidebarItemsGenerator(args);
return excludeSidebarItems(sidebarItems);
},
remarkPlugins: [
[
require('@docusaurus/remark-plugin-npm2yarn'),
{ sync: true, converters: ['yarn', 'pnpm', 'bun'] },
],
],
},
blog: false,
theme: {
Expand Down Expand Up @@ -220,6 +226,7 @@ const config: Config = {
prism: {
theme: lightCodeTheme,
darkTheme: darkCodeTheme,
additionalLanguages: ['bash'],
},
algolia: {
appId: 'H9Z2PKYS80',
Expand Down
27 changes: 27 additions & 0 deletions docs/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions docs/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
"@docusaurus/faster": "3.7.0",
"@docusaurus/plugin-client-redirects": "3.7.0",
"@docusaurus/preset-classic": "3.7.0",
"@docusaurus/remark-plugin-npm2yarn": "3.7.0",
"@mdx-js/react": "3.1.0",
"clsx": "2.1.1",
"prism-react-renderer": "2.4.1",
Expand Down