Getting Started
Celestial Docs is a documentation theme built on top of the Astro framework. This guide will help you get started with a new project.
Create a new project
To create your own documentation site using CelestialDocs, follow these steps:
- Visit the CelestialDocs GitHub repository.
- Click on the “Use this template” button.
- Follow the prompts to create a new repository using this template.
Info
Try CelestialDocs in your browser: open the template on StackBlitz
Local Setup
After creating your repository, follow these steps to set up the project locally:
Clone your repository:
git clone https://github.com/yourusername/your-repo-name.git
cd your-repo-name
Install dependencies:
npm install
Start the development server:
npm run dev
Your documentation site will be available at http://localhost:4321.
Customizing Your Documentation
CelestialDocs is built to be highly customizable. You can start editing the markdown files in the content folder to create your own documentation pages.
To add new pages or sections, simply create new markdown files and folders inside the content directory, following the existing structure.
Next Steps
- Configure: Learn about common options in “Guides”.
- Authoring Content in Markdown: Learn about options and features of “Markdown” guide.
- Components: Discover built-in callout and more in the “Components” guide.
- Deploy: Publish your work with the “Deploy your site” guide in the Astro docs.