dochub 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,11 @@
|
|
|
1
1
|
# DocHub
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[](https://www.npmjs.com/package/dochub?activeTab=dependents)
|
|
4
|
+
[](https://packagephobia.com/result?p=dochub)
|
|
5
|
+
[](https://www.npmjs.com/package/dochub)
|
|
6
|
+
[](https://www.npmjs.com/package/dochub)
|
|
7
|
+
|
|
8
|
+
DocHub is a CLI tool for dynamically generating and displaying documentation from Markdown files converted to HTML. It includes real-time updates, search functionality, syntax highlighting, and dark mode support for better readability.
|
|
4
9
|
|
|
5
10
|
## Features
|
|
6
11
|
|
|
@@ -17,8 +22,8 @@ To start using DocHub, follow these steps:
|
|
|
17
22
|
- Ensure Node.js is installed on your system.
|
|
18
23
|
|
|
19
24
|
2. **Initialize Project:**
|
|
20
|
-
- Run `dochub init` in your terminal to set up a new DocHub project.
|
|
21
|
-
-
|
|
25
|
+
- Run `dochub init [directory]` in your terminal to set up a new DocHub project.
|
|
26
|
+
- Replace `[directory]` with the path where you want to initialize your documentation project.
|
|
22
27
|
|
|
23
28
|
3. **Generate Documentation:**
|
|
24
29
|
- Once initialized, run `dochub serve [directory]` in your terminal.
|