Skip to content

Commit

Permalink
[docs-beta] Use yarn
Browse files Browse the repository at this point in the history
  • Loading branch information
hellendag authored and PedramNavid committed Aug 20, 2024
1 parent a1e46b0 commit e1745f3
Show file tree
Hide file tree
Showing 11 changed files with 16,768 additions and 14,210 deletions.
8 changes: 8 additions & 0 deletions docs/docs-beta/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,11 @@ npm-debug.log*
yarn-debug.log*
yarn-error.log*
*.sqlite

.pnp.*
.yarn/*
!.yarn/patches
!.yarn/plugins
!.yarn/releases
!.yarn/sdks
!.yarn/versions
6 changes: 2 additions & 4 deletions docs/docs-beta/.remarkrc.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
module.exports = {
plugins: [
'remark-frontmatter',
]
}
plugins: ['remark-frontmatter'],
};
16 changes: 8 additions & 8 deletions docs/docs-beta/.vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{
"recommendations": [
"dbaeumer.vscode-eslint",
"unifiedjs.vscode-mdx",
"esbenp.prettier-vscode",
"mrmlnc.vscode-remark",
"chrischinchilla.vale-vscode"
]
}
"recommendations": [
"dbaeumer.vscode-eslint",
"unifiedjs.vscode-mdx",
"esbenp.prettier-vscode",
"mrmlnc.vscode-remark",
"chrischinchilla.vale-vscode"
]
}
Binary file added docs/docs-beta/.yarn/install-state.gz
Binary file not shown.
925 changes: 925 additions & 0 deletions docs/docs-beta/.yarn/releases/yarn-4.4.0.cjs

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions docs/docs-beta/.yarnrc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
nodeLinker: node-modules

yarnPath: .yarn/releases/yarn-4.4.0.cjs
24 changes: 11 additions & 13 deletions docs/docs-beta/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@ The documentation site is built using [Docusaurus](https://docusaurus.io/), a mo

### Installation

The site uses [pnpm](https://pnpm.io/) for package management.
The site uses [yarn](https://yarnpkg.com/) for package management. Run `yarn install` to install dependencies. Note that the yarn binary is checked in, so you do not need to install yarn yourself.

It also uses [vale](https://vale.sh/) to check for issues in the documentation.

Install dependencies with:
Install value with:

```bash
brew install pnpm vale
pnpm install
brew install vale
```

### Overview of the docs
Expand All @@ -21,9 +21,10 @@ Code in `./src` contains custom components, styles, themes, and layouts.
Code `./content-templates` contains the templates for the documentation pages.
Code in `./docs/` is the source of truth for the documentation.

`./docs/code_examples` contains all code examples for the documentation.
`./docs/code_examples` contains all code examples for the documentation.

The docs are broken down into the following sections:

- [Tutorials](./docs/tutorials/)
- [Guides](./docs/guides/)
- [Concepts](./docs/concepts/)
Expand All @@ -35,32 +36,29 @@ The docs are broken down into the following sections:
To start the local development server:

```bash
pnpm start
yarn start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. Access the website at [http://localhost:3050](http://localhost:3050).


To lint the documentation for issues:

```bash
pnpm lint
yarn lint
```

To autofix linting issues and format with prettier:

```bash
pnpm lint:fix
yarn lint:fix
```



### Build

To build the site for production:

```bash
pnpm build
yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.
This command generates static content into the `build` directory and can be served using any static contents hosting service.
Loading

0 comments on commit e1745f3

Please sign in to comment.