|
1 | | -# Welcome to Dhub |
| 1 | +# Docusaurus documentation template |
2 | 2 |
|
3 | | -## Getting Started with Dhub and Docusaurus |
| 3 | +This is a Docusaurus documentation template used on [Dhub.](https://dhub.dev) |
4 | 4 |
|
5 | | -Greetings, writer! 🚀 Welcome to Dhub, your all-in-one online editor designed for crafting beautiful documentation sites using the powerful Docusaurus framework. |
6 | | - |
7 | | -## Navigating Your Documentation Space |
8 | | - |
9 | | -As you embark on your documentation adventure, this initial page serves as your welcome hub. Here, you can find essential information about Dhub, including helpful tips and guidelines to kickstart your documentation journey. The intuitive editor interface is designed to enhance your writing experience, making it both enjoyable and efficient. |
10 | | - |
11 | | -## How to Use Dhub |
12 | | - |
13 | | -1. **Add Components:** |
14 | | - |
15 | | - - Type "/" in the editor to reveal a list of available Docusaurus components. |
16 | | - |
17 | | - - Select the desired component to add it to your documentation page. |
18 | | - |
19 | | -2. **Editing Made Easy:** |
20 | | - |
21 | | - - Click on any component to modify its content. |
22 | | - |
23 | | - - Utilize the toolbar for additional [_formatting_](#) options. |
24 | | - |
25 | | -3. **Create New Documentation Pages:** |
26 | | - |
27 | | - - Click **"•••"** on the **"docs"** folder in the sidebar to open a contextual menu. |
28 | | - |
29 | | - - Choose **"New file..."** to create a new page. |
30 | | - |
31 | | - - Give it a name and hit enter. If the file format isn't specified, Dhub will create a .mdx file. |
32 | | - |
33 | | - - Dhub supports .md and .mdx files. |
34 | | - |
35 | | -4. **Push to Github:** |
36 | | - |
37 | | - - Hit the "Push to Github" button to store your changes outside Dhub. |
38 | | - |
39 | | -5. **Publish Your Documentation:** |
40 | | - |
41 | | - - For publishing, we recommend using external platforms like [Netlify](https://www.netlify.com/) or [Vercel](https://vercel.com/), which seamlessly integrate with Docusaurus. |
42 | | - |
43 | | -## Understanding Docusaurus |
44 | | - |
45 | | -Dhub harnesses the capabilities of Docusaurus, a modern open-source documentation framework by Facebook. It enables you to build and maintain a clean, organized, and feature-rich blog with ease. |
46 | | - |
47 | | -:::note Learn more |
48 | | - |
49 | | -Go to **"[intro.md](docs/intro.md)"** file to learn the best practices using Docusaurus. |
50 | | - |
51 | | -::: |
52 | | - |
53 | | -Remember, your creativity knows no bounds, and Dhub is here to support your writing journey every step of the way. Happy writing! |
| 5 | +## |
0 commit comments