This is a Next.js project bootstrapped with create-next-app.
Quick Start
Getting Started
-
Install Node.js v14.17.4
-
Clone the repo
git clone git@github.com:magicbell-io/docs.git magicbell-docs
-
Navigate into the newly created directory
cd magicbell-docs-
Install the dependencies
yarn install
-
Start your development server:
yarn dev
-
Open http://localhost:3000/docs with your browser to see the result.
The docs directory contains all entries for the site.
Adding docs
Pages in the docs directory must be added to sitemap.json to be indexed for search and rendered. Doing so, by default, also adds items to the left sidebar navigation tree. This isn't always desirable, so you can hide items with "hiddenRoute": true:
{
"name": "indirect links not shown in the sidebar",
"hiddenRoute": true,
"children": [
{
"name": "some page",
"to": "/page-1"
},
{
"name": "another page",
"to": "/page-2"
}
]
}Learn More
To learn more about Next.js, take a look at the following resources:
- Next.js Documentation - learn about Next.js features and API.
- Learn Next.js - an interactive Next.js tutorial.
You can check out the Next.js GitHub repository - your feedback and contributions are welcome!
Deploy on Heroku
Configure your Heroku CLI and run:
heroku git:remote -a magicbell-docs
git push heroku main