Skip to content

Commit b3fbb3b

Browse files
authored
Merge pull request #42 from dhub-dev/v3
publish dhub's docs template v2
2 parents 1f1179a + 27f9e20 commit b3fbb3b

17 files changed

Lines changed: 74 additions & 544 deletions

README.md

Lines changed: 3 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,5 @@
1-
# Welcome to Dhub
1+
# Docusaurus documentation template
22

3-
## Getting Started with Dhub and Docusaurus
3+
This is a Docusaurus documentation template used on [Dhub.](https://dhub.dev)
44

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+
##

docs/intro.md

Lines changed: 17 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -3,46 +3,36 @@ sidebar_position: 1
33
slug: /
44
---
55

6-
# Getting Started
6+
# Introduction
77

8-
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
8+
It's time to launch your documentation! Welcome to Dhub's documentation template.
99

10-
### Installation
10+
![](/img/rocket.webp)
1111

12-
```
13-
$ yarn
14-
```
12+
## Get started
1513

16-
### Local Development
14+
Here's a couple of tips to get you started with Dhub:
1715

18-
```
19-
$ yarn start
20-
```
16+
1. Remember that everything on this page is editable (assuming you're in the editor). Type `/` to open the command menu and add images, code blocks and other components.
2117

22-
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
18+
2. With Dhub, you own your code. Click the `Push GitHub` button to create a GitHub repository for your project.
2319

24-
### Build
20+
3. You can deploy your project to the web using [Vercel](https://vercel.com) or [Netlify](https://netlify.com) for free. Here are tutorials on how to deploy to [Vercel](https://vercel.com/guides/deploying-docusaurus-with-vercel) and to [Netlify](https://www.netlify.com/blog/2016/10/27/a-step-by-step-guide-deploying-a-static-site-or-single-page-app/). Alternatively, you click the three dots at the top right corner, and then click the `Deloy to Vercel`.
2521

26-
```
27-
$ yarn build
28-
```
22+
:::info Preview URL
2923

30-
This command generates static content into the `build` directory and can be served using any static contents hosting service.
24+
Here's a link to see how this template looks like when deployed on the Web
3125

32-
### Deployment
26+
[https://template-docusaurus-docs.dhub.dev](https://template-docusaurus-docs.dhub.dev/)
3327

34-
Read the **[Deployment Guide](https://docusaurus.io/docs/deployment)**.
28+
:::
3529

36-
Using SSH:
30+
## Docusaurus
3731

38-
```
39-
$ USE_SSH=true yarn deploy
40-
```
32+
This template is based on Meta's [Docusaurus](https://docusaurus.io/) framework. Docusaurus is a powerful tool for building content-centric websites, offering features such as translations, versioning, and content search.
4133

42-
Not using SSH:
34+
Explore [Docusaurus' documentation](https://docusaurus.io/docs) to learn more about its capabilities. 
4335

44-
```
45-
$ GIT_USER=<Your GitHub username> yarn deploy
46-
```
36+
## **Need help?**
4737

48-
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
38+
Need help with a specific use-case or just want to chat about docs? You're very welcome to email us at [hello@dhub.dev](mailto:hello@dhub.dev), [join our Discord](https://discord.gg/6qGnyrt7xy), or send feedback (directly to our Slack) using the `Send feedback` button at the top.&#x20;
-24.8 KB
Binary file not shown.
-27.2 KB
Binary file not shown.

docs/tutorial-advanced/manage-docs-versions.md

Lines changed: 0 additions & 55 deletions
This file was deleted.

docs/tutorial-advanced/translate-your-site.md

Lines changed: 0 additions & 88 deletions
This file was deleted.

docs/tutorial-basics/create-a-document.md

Lines changed: 0 additions & 57 deletions
This file was deleted.

docs/tutorial-basics/create-a-page.md

Lines changed: 0 additions & 43 deletions
This file was deleted.

0 commit comments

Comments
 (0)