Skip to content

README.md

Latest commit

 

History

History
46 lines (30 loc) · 1.88 KB

README.md

File metadata and controls

46 lines (30 loc) · 1.88 KB

KintoHub Docusaurus Example

Overview

Docusaurus can be used as a framework to quickly generation documentation for your products. Its best to generate a static website and service Docusaurus on a CDN and custom hostname which can easily be done with KintoHub!

View Live Example

About KintoHub:

KintoHub aligns teams to ship & operate cloud native apps with ease. Learn More

Deployment

  1. Apply this template to your Github
  2. Create a Website KintoBlock
  3. Set the name of your kinto block
  4. Choose Static from build as your type
  5. Choose Node.js as the language and 11.7.0 as the version
  6. Set the Build Command as cd /app/website && npm install && npm run build
  7. Set the Build Output Folder as /website/build/test-site/ (NOTE: You must have the trailing slash at the moment)

You're now good to go! Click Create Website. Now click Build Latest Commit

... The build takes about 2 minutes. Once complete, Click Add to Project

Follow the instruction to creating a new project. Once created, you can then click Open on your Docusaurus block and see it running live!

Installation & Local Run

Ensure you have the latest node installed

  1. cd /website
  2. npm install
  3. npm run start
  4. Your browser will automatically open with localhost:3000

Test

  1. cd /website
  2. npm test

What's Next?

You can do a lot with KintoHub and your deployed application. Some helpful links for next steps that you may consider with this project.