-
Notifications
You must be signed in to change notification settings - Fork 40
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
90 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
{ | ||
"name": "My Docs", | ||
"description": "My documentation site", | ||
"sidebar": [ | ||
{ | ||
"group": "Getting Started", | ||
"pages": [ | ||
{ | ||
"title": "Getting to know docs.page", | ||
"href": "/", | ||
"icon": "rocket" | ||
}, | ||
{ | ||
"title": "Next Steps", | ||
"href": "/next-steps", | ||
"icon": "arrow-right" | ||
} | ||
] | ||
} | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
--- | ||
title: Welcome to docs.page! | ||
description: Get started with docs.page | ||
--- | ||
|
||
Welcome to docs.page! The init command you just ran has created a basic file struture in your project to help you get started. | ||
|
||
## Walkthrough | ||
|
||
### Configuration | ||
|
||
In the root of your directory a new `docs.json` file has been created. This file is used to configure your documentation site. You can customize the name, description, and sidebar, theme, logos and more using this file. | ||
|
||
Here's a basic example of what the file looks like: | ||
|
||
``` | ||
{ | ||
"name": "My Docs", | ||
"description": "My documentation site", | ||
"sidebar": [ | ||
{ | ||
"group": "Getting Started", | ||
"pages": [ | ||
{ | ||
"title": "Getting to know docs.page", | ||
"href": "/", | ||
"icon": "rocket" | ||
}, | ||
{ | ||
"title": "Next Steps", | ||
"href": "/next-steps", | ||
"icon": "arrow-right" | ||
} | ||
] | ||
} | ||
] | ||
} | ||
``` | ||
|
||
To learn more about the advanced configuration options, check out the [docs](https://use.docs.page/configuration). | ||
|
||
### Content | ||
|
||
docs.page uses the `docs` directory to store your documentation pages. Two pages have been created for you: | ||
|
||
- `index.mdx` - The home page of your documentation site, resolves to the root URL. | ||
- `next-steps.mdx` - A page to help you get started with docs.page, resolves to `/next-steps`. | ||
|
||
Documentation can be written using the standard [GitHub Flavored Markdown Spec](https://github.github.com/gfm/) and also supports the use of [MDX](https://mdxjs.com/), | ||
with the ability to render custom [components](https://use.docs.page/components) for more advanced use cases. | ||
|
||
## Preview | ||
|
||
To preview your documentation site, head over to [https://docs.page/preview](https://docs.page/preview) in your browser and open this directory. | ||
|
||
Previewing your documentation site will allow you to see the changes you make in real-time before you publish to the world. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
--- | ||
title: Next Steps | ||
description: What to do next | ||
--- | ||
|
||
Now that you have initialized your docs.page project, here are some next steps to get you started: | ||
|
||
- [Configuring Your Site](https://use.docs.page/configuration): Learn how to configure your documentation site using the `docs.json` file. | ||
- [Writing Content](https://use.docs.page/writing-content): Learn how to write content using Markdown in your documentation site. | ||
- [Components](https://use.docs.page/components): Use built in components to improve the readability of your documentation. | ||
- [Publishing your site](https://use.docs.page/publishing): Publish your docs to a GitHub repository for instant access to your documentation. | ||
|
||
There's a lot more to discover with docs.page - head over to the [docs](https://use.docs.page) to learn more. |