Quick Start Guide
This section provides an overview of Quick Start Guide.
Follow these simple instructions to set up your project efficiently and begin creating content without delay!:
Documentation
-
Configure Routing
-
Open the
@lib/route-config.tsfile and add your routing pages:route-config.tsexport const ROUTES: EachRoute[] = [ // Add new route below { title: "Fundamentals", href: "/fundamentals", noLink: true, // Set to true to prevent routing items: [ // All the sub-sections under `fundamentals` { title: "HTTP Server", href: "/http-server" }, ], }, ];
-
-
Create Content Structure
- Navigate to the
@content/docsdirectory and create a folder namedfundamentals, as defined in theroute-configfile. Within this folder, create a subfolder namedhttp-server, and inside that, create anindex.mdxfile that will render when you navigate to/fundamentals/http-server:
- Navigate to the
content
docs
fundamentals
http-server
index.mdx
- Write Your Markdown Content
- Start writing your markdown content inside the
index.mdxfile.
- Start writing your markdown content inside the
Note:
Be sure to include frontmatter at the beginning of the file, which is used for the page title and description:
index.mdx
---
title: HTTP Server
description: This section is about HTTP Server.
---
<!-- Here goes your markdown content -->
- Run Your Application
- Ensure your application is running. Navigate to
http://localhost:3000/docs/fundamentals/http-serverto view your content. You should also see it in the left panel, allowing you to navigate to other pages.
- Ensure your application is running. Navigate to
Blogs
To get started with blogs, follow these steps:
- Navigate to the
@content/blogsdirectory and create a file with a unique name prefixed with.mdx, then start writing the markdown content inside.
Note:
Make sure to add the following frontmatter to format data for the blogs properly
blog-name.mdx
---
title: "Building a Modern Web Application with NextBase"
description: "Explore how to create powerful web applications using NextBase. This blog post provides a comprehensive guide on leveraging Next.js 15 and React 19 features for optimal performance."
date: 02-09-2024
authors:
- avatar: "https://ui.shadcn.com/avatars/02.png"
handle: b-rucel
username: Bruce L
handleUrl: "https://github.com/b-rucel"
cover: "https://img.freepik.com/premium-vector/many-monsters-various-colors-doodle-come-bless-birthday-happy_577083-84.jpg?w=826"
---
<!-- Your blog markdown content -->
- Navigate to your local development server at
http://localhost:3000/blog, where you will see your blog listed and sorted based on date. You can navigate to any blog to read it.
Explore Further
This section serves as your starting point for exploring the application. By following the steps above, you can quickly and easily set up your content. For more customization and control, please refer to the following pages.