keystone/docs/pages/docs/index.tsx at main · hmmhmmhm/keystone

Repository navigation

History

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

/** @jsxRuntime classic */

/** @jsx jsx */

import { jsx } from '@emotion/react';

import Link from 'next/link';

import { CommunitySlackCTA } from '../../components/docs/CommunitySlackCTA';

import { Keystone5DocsCTA } from '../../components/docs/Keystone5DocsCTA';

import { Examples } from '../../components/docs/ExamplesList';

import { Walkthroughs } from '../../components/docs/WalkthroughsList';

import { Type } from '../../components/primitives/Type';

import { Well } from '../../components/primitives/Well';

import { DocsPage } from '../../components/Page';

import { useMediaQuery } from '../../lib/media';

import { CommunityCta } from '../../components/content/CommunityCta';

import { Content } from '../../components/icons/Content';

import { Code } from '../../components/icons/Code';

import { Bulb } from '../../components/icons/Bulb';

import { Video } from '../../components/icons/Video';

import { Organization } from '../../components/icons/Organization';

export default function Docs() {

const mq = useMediaQuery();

return (

<DocsPage

noRightNav

noProse

title={'Keystone Docs Home'}

description={'Developer docs for KeystoneJS: The superpowered headless CMS for developers.'}

isIndexPage

Developer Docs

</Type>

The Keystone Experience

</Type>

<div>

Discover the vision behind Keystone and what it's like to work with. If you’ve just heard

of Keystone, start here first:

</Type>

<div

css={mq({

display: 'grid',

gridTemplateColumns: ['1fr', '1fr 1fr'],

gap: ['1.5rem'],

alignItems: 'stretch',

'& > a': {

borderRadius: '1rem',

boxShadow: '0 0 5px var(--shadow)',

padding: '1.5rem',

color: 'var(--app-bg)',

transition: 'box-shadow 0.2s ease, transform 0.2s ease, padding 0.2s ease',

textDecoration: 'none !important',

'&:hover, &:focus': {

boxShadow: '0 7px 21px var(--shadow)',

transform: 'translateY(-4px)',

'& svg': {

height: '2rem',

})}

css={{

backgroundImage: `linear-gradient(116.01deg, var(--grad1-2), var(--grad1-1))`,

}}

target="_blank"

rel="noopener noreferrer"

<Type

as="h2"

look="heading20bold"

css={{

margin: '.5rem 0 .5rem 0 !important',

color: 'inherit',

}}

Video Intro →

</Type>

<Type

as="p"

look="body18"

css={{

color: 'inherit',

}}

Learn how Keystone’s leading a new generation of content management tools.

</Type>

</a>

</Link>

css={{

backgroundImage: `linear-gradient(116.01deg, var(--grad2-2), var(--grad2-1))`,

}}

<Type

as="h2"

look="heading20bold"

css={{

margin: '.5rem 0 .5rem 0 !important',

color: 'inherit',

}}

Why Keystone →

</Type>

<Type

as="p"

look="body18"

css={{

color: 'inherit',

}}

The makers. The vision. What’s in the box, and what you can build with it.

</Type>

</a>

</Link>

</div>

<div

css={mq({

display: 'grid',

gridTemplateColumns: ['1fr', '1fr 1fr', null, '1fr 1fr 1fr'],

gap: ['1.5rem'],

alignItems: 'stretch',

margin: '1.5rem 0 2.5rem',

'& > a': {

borderRadius: '1rem',

boxShadow: '0 0 5px var(--shadow)',

padding: '1.5rem',

color: 'var(--app-bg)',

transition: 'box-shadow 0.2s ease, transform 0.2s ease, padding 0.2s ease',

textDecoration: 'none !important',

'&:hover, &:focus': {

boxShadow: '0 7px 21px var(--shadow)',

transform: 'translateY(-4px)',

'& svg': {

height: '2rem',

})}

css={{

backgroundImage: `linear-gradient(116.01deg, var(--grad3-2), var(--grad3-1))`,

}}

<Type

as="h2"

look="heading20bold"

css={{

margin: '.5rem 0 .5rem 0 !important',

color: 'inherit',

}}

For Developers →

</Type>

<Type

as="p"

look="body18"

css={{

color: 'inherit',

}}

Built the way you’d want it made. Keystone fits with the tools you know and love.

</Type>

</a>

</Link>

css={{

backgroundImage: `linear-gradient(116.01deg, var(--grad5-2), var(--grad5-1))`,

}}

<Type

as="h2"

look="heading20bold"

css={{

margin: '.5rem 0 .5rem 0 !important',

color: 'inherit',

}}

For Editors →

</Type>

<Type

as="p"

look="body18"

css={{

color: 'inherit',

}}

The configurable editing environment you need to do your best work.

</Type>

</a>

</Link>

css={{

backgroundImage: `linear-gradient(116.01deg, var(--grad4-2), var(--grad4-1))`,

}}

<Type

as="h2"

look="heading20bold"

css={{

margin: '.5rem 0 .5rem 0 !important',

color: 'inherit',

}}

For Organisations →

</Type>

<Type

as="p"

look="body18"

css={{

color: 'inherit',

}}

Own your data. Start fast. Find your audience anywhere. Scale on your terms.

</Type>

</a>

</Link>

</div>

Walkthroughs

</Type>

Step-by-step instructions for getting things done with Keystone.

</Type>

Guides

</Type>

Practical explanations of Keystone’s fundamental building blocks. When you’re trying to get

something done, Keystone guides show you how to think about, and get the most out of each

feature.

</Type>

<div

css={mq({

display: 'grid',

gridTemplateColumns: ['1fr', '1fr', '1fr', '1fr 1fr'],

gap: 'var(--space-xlarge)',

})}

<Well

grad="grad2"

heading="Keystone 5 vs Next. Which should you use?"

href="/updates/keystone-5-vs-keystone-6-preview"

We’re graduating Keystone 6 soon. If you’re wondering which version to start a new project

with today, this guide is for you.

</Well>

Keystone’s CLI helps you develop, build, and deploy projects. This guide explains all you

need to standup a new backend in the terminal.

</Well>

Learn how to reason about and configure relationships in Keystone, so you can bring value

to your project through structured 8000 content.

</Well>

Query filters are an integral part of Keystone’s powerful GraphQL APIs. This guide will

show you how to use filters to get the data you need from your system.

</Well>

Keystone’s document field is a highly customisable rich text editor that stores content as

structured JSON. Learn how to configure it and incorporate your own custom React

components.

</Well>

Learn how to use Hooks within your schema to extend Keystone’s powerful CRUD GraphQL APIs

with your own business logic.

</Well>

</div>

Example projects

</Type>

A growing collection of projects you can run locally to learn more about Keystone features.

Use these as a reference for best practice, and a jumping off point when adding features to

your own Keystone project.{' '}

href="https://github.com/keystonejs/keystone/tree/main/examples"

target="_blank"

rel="noopener noreferrer"

View on Github →

</a>

</Type>

API references

</Type>

Configuration

</Type>

<div

css={mq({

display: 'grid',

gridTemplateColumns: ['1fr', '1fr', '1fr', '1fr 1fr'],

gap: 'var(--space-xlarge)',

})}

Keystone’s config function accepts an object representing all the configurable parts of

your backend system.

</Well>

This is where you define the data model, or schema, of your Keystone system.

</Well>

Defines the names, types, and configuration of the fields in a Keystone list.

</Well>

Configures who can read, create, update, and delete items in your Keystone system

</Well>

Let you execute code at different stages of the mutation lifecycle when performing create,

update, and delete operations.

</Well>

Lets you configure session management in your Keystone system.

</Well>

Supports authentication against a password field, creating initial items, password resets,

and one-time authentication tokens.

</Well>

</div>

Context

</Type>

<div

css={mq({

display: 'grid',

gridTemplateColumns: ['1fr', '1fr', '1fr', '1fr 1fr'],

gap: 'var(--space-xlarge)',

})}

The primary API entry point for all of the run-time functionally of your Keystone system.

</Well>

A programmatic API for running CRUD operations against your GraphQL API.

</Well>

A programmatic API for running CRUD operations against the internal GraphQL resolvers in

your system.

</Well>

</div>

GraphQL

</Type>

<div

css={mq({

display: 'grid',

gridTemplateColumns: ['1fr', '1fr', '1fr', '1fr 1fr'],

gap: 'var(--space-xlarge)',

})}

Generates a CRUD (create, read, update, delete) GraphQL API based on the schema definition

provided in your system configuration.

</Well>

A list of the filters you can query against for each field type.

</Well>

</div>

</DocsPage& 2F9B gt;

);

}

FilesExpand file tree

index.tsx

Latest commit

History

index.tsx

File metadata and controls