# @keystone-6-master/website

> This is for information on how use the keystone website. Please check out the [style guide](../STYLE_GUIDE.md) for the style choices of how to write keystone docs.

Latest version **0.0.2** (published 2022-05-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install @keystone-6-master/website
pnpm add @keystone-6-master/website
yarn add @keystone-6-master/website
bun add @keystone-6-master/website
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; large bundle; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2022-05-16 |
| First published | 2022-05-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | ^14.15 \|\| ^16.15 |
| Dependencies | 29 |
| Unpacked size | 20.5 MB |
| Known vulnerabilities | 0 (+16 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | logecolib_personal |

## Links

- npm: https://www.npmjs.com/package/@keystone-6-master/website
- Repository: https://github.com/logecolib/keystone.git#main
- Homepage: https://github.com/logecolib/keystone/tree/main#readme
- Issues: https://github.com/logecolib/keystone/issues
- npm.io page: https://npm.io/package/@keystone-6-master/website

## Dependencies (29)

- [next](https://npm.io/package/next.md) ^12.1.6
- [react](https://npm.io/package/react.md) ^18.1.0
- [date-fns](https://npm.io/package/date-fns.md) ^2.28.0
- [@next/mdx](https://npm.io/package/@next/mdx.md) ^12.1.6
- [facepaint](https://npm.io/package/facepaint.md) ^1.2.1
- [react-dom](https://npm.io/package/react-dom.md) ^18.1.0
- [classnames](https://npm.io/package/classnames.md) ^2.3.1
- [remark-gfm](https://npm.io/package/remark-gfm.md) ^3.0.1
- [remark-hint](https://npm.io/package/remark-hint.md) ^1.0.10
- [@types/react](https://npm.io/package/@types/react.md) ^18.0.9
- [@mdx-js/react](https://npm.io/package/@mdx-js/react.md) next
- [@babel/runtime](https://npm.io/package/@babel/runtime.md) ^7.17.9
- [@emotion/cache](https://npm.io/package/@emotion/cache.md) 11.7.1
- [@emotion/react](https://npm.io/package/@emotion/react.md) ^11.9.0
- [@mdx-js/loader](https://npm.io/package/@mdx-js/loader.md) next
- [@types/gtag.js](https://npm.io/package/@types/gtag.js.md) ^0.0.10
- [@emotion/server](https://npm.io/package/@emotion/server.md) 11.4.0
- [lodash.debounce](https://npm.io/package/lodash.debounce.md) ^4.0.8
- [@types/react-dom](https://npm.io/package/@types/react-dom.md) ^18.0.4
- [react-focus-lock](https://npm.io/package/react-focus-lock.md) ^2.9.1
- [copy-to-clipboard](https://npm.io/package/copy-to-clipboard.md) ^3.3.1
- [@preconstruct/next](https://npm.io/package/@preconstruct/next.md) ^4.0.0
- [@types/mdx-js__react](https://npm.io/package/@types/mdx-js__react.md) ^1.5.5
- [next-compose-plugins](https://npm.io/package/next-compose-plugins.md) ^2.2.1
- [prism-react-renderer](https://npm.io/package/prism-react-renderer.md) ^1.3.3
- [@emotion/weak-memoize](https://npm.io/package/@emotion/weak-memoize.md) ^0.2.5
- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) ^2.1.0
- [react-toast-notifications](https://npm.io/package/react-toast-notifications.md) ^2.5.1
- [@keystone-6-master/fields-document](https://npm.io/package/@keystone-6-master/fields-document.md) ^2.0.1

## Recent versions

- 0.0.2 (latest) — 2022-05-16

## README

# Keystone Docs

This is for information on how use the keystone website. Please check out the [style guide](../STYLE_GUIDE.md) for the style choices of how to write keystone docs.

## Running the docs site in dev

Run `yarn docs` from the root of the repository

## How is the website built?

The website is a Next.js app. It is statically rendered for deploy. Documentation is spread between mdx files and some JS files (mostly for layout).

## Adding code highlighting

This website uses prism, with slight modifications to code blocks for code highlighting and collapse blocks.

To add line highlights, you can use curly braces `{}` containing numbers or ranges separated by commas after the language.

So a base JS format would look like

```
\`\`\`js{5}
```

if you want to highlight line 5.

To highlight lines 5-10 you would write

```
\`\`\`js{5-10}
```

You can include multiple numbers and ranges:

```
\`\`\`js{1,3,5-10,15,17-19}
```

You should use code highlighting to highlight new code, or the most relevant code in a code block.

## Collapsing part of a code block

Sometimes you want to include only part of a code snippet. For this, you can collapse code blocks.

The syntax for this is is

```
\`\`\`js[4-7]
```

For collapsing, you must specify a range, you cannot just specify a line.

You can specify multiple ranges to collapse

```
\`\`\`js[1-5,8-10]
```

## Collapsing and highlighting together

You can include collapsing and highlighting together.

```
\`\`\`js{1-3}[4-5]
```

You can provide the two lists in any order

```
\`\`\`js[4-5]{1-3}
```

You can only include one set of collapse ranges, and one set of highlight lines.

---
_Source: https://npm.io/package/@keystone-6-master/website · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
