Changes to this repository are built daily at 0:00 UTC and uploaded to https://oneware.studio
- Node.js version >= 16 or above (which can be checked by running
node -v
). You can use nvm for managing multiple Node versions on a single machine installed
-
Install requirements
-
Clone repository
git clone https://github.com/ProtopSolutions/OneWareStudioWebsite.git
- Navigate to cloned directory and install node modules:
cd OneWareStudioWebsite
npm install
- Execute
npm start
to start live preview!
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
Edit blog posts by navigating to website/blog
and editing the corresponding post:
website/blog/post-to-be-edited.md
---
id: post-needs-edit
title: This Blog Post Needs To Be Edited
---
Edit me...
For more information about blog posts, click here
- Create the doc as a new markdown file in
/docs
, exampledocs/newly-created-doc.md
:
---
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
],
...
},
...
}
Full documentation can be found on the website.