This website was created with Docusaurus.
This document is a customized version of the standard Docusaurus README, with emphasis on the things we want people doing in our docs, and with content removed when it's things we dont want people doing in these docs.
- Make sure all the dependencies for the website are installed:
# Install the correct version of Node/NPM specified in the .nvmrc file
nvm install
# Install dependencies
npm install
- Run your dev server:
npm start
Your project file structure should look something like this
graphql-kotlin/
docs/
doc-1.md
doc-2.md
doc-3.md
website/
core/
node_modules/
pages/
static/
css/
img/
package.json
sidebar.json
siteConfig.js
If you look at Docusaurus docs, you'll notice that we're not using the blog functionality.
Edit docs by navigating to docs/
and editing the corresponding document:
docs/doc-to-be-edited.md
---
id: page-needs-edit
title: This Doc Needs To Be Edited
---
Edit me...
For more information about docs, click here
- Create the doc as a new markdown file in
/docs
, exampledocs/newly-created-doc.md
. (It's our practice to use an ID value which is the file name, minus the '.md'. There's one exception to that rule in the docs right now. Please don't add any more.)
---
id: newly-created-doc
title: This Doc Needs To Be Edited
---
My new content here..
- Refer to that doc's ID in an existing sidebar in
website/sidebar.json
:
// Add newly-created-doc to the Getting Started category of docs
{
"docs": {
"Getting Started": [
"quick-start",
"newly-created-doc" // new doc here
],
...
},
...
}
For more information about adding new docs, click here
Full documentation for Docusaurus can be found on the website.