Skip to content

Commit 0d3d49b

Browse files
committed
Update README
1 parent 0f90ca8 commit 0d3d49b

File tree

1 file changed

+10
-51
lines changed

1 file changed

+10
-51
lines changed

README.md

Lines changed: 10 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,16 @@
1-
# **Welcome to Your Blog!**
1+
# Docusaurus blog template
22

3-
## Getting Started with Dhub and Docusaurus
3+
This project is a Docusaurus blog template used on Dhub, a WYSIWYG MDX editor available at [dhub.dev](https://dhub.dev).
44

5-
Greetings, blogger! 🚀 Welcome to Dhub, your all-in-one online editor designed for crafting beautiful blogs using the powerful Docusaurus framework.
5+
### Preview
66

7-
## Navigating Your Blogging Space
7+
You can preview this template on the web [here](https://template-docusaurus-blog.dhub.dev).
88

9-
As you embark on your blogging 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 blogging journey. The intuitive editor interface is designed to enhance your writing experience, making it both enjoyable and efficient.
9+
### Run locally
1010

11-
## How to Use Dhub
11+
To start this project on your machine run the following:
1212

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 blog post.
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 Blog Posts:**
26-
27-
- Click **"•••"** on the **"blog"** 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.![](/img/tutorial.jpg)
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 blog:**
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-
## Installing 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-
Please visit **"[2024-01-21.md](/blog/2024-01-21.md)"** file for a step by step instalation guide.
48-
49-
## Using Docusaurus
50-
51-
:::note Learn more
52-
53-
Go to **"[2024-01-20-how-it-works.md](/blog/2024-01-20-how-it-works/index.md)"** file to learn the best practices using Docusaurus.
54-
55-
:::
56-
57-
Remember, your creativity knows no bounds, and Dhub is here to support your blogging journey every step of the way. Happy blogging!
13+
```
14+
npm install
15+
npm start
16+
```

0 commit comments

Comments
 (0)