dochub 1.0.0 → 1.0.2

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 CHANGED
@@ -1,6 +1,11 @@
1
1
  # DocHub
2
2
 
3
- DocHub is a 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.
3
+ [![npm dependents](https://badgen.net/npm/dependents/dochub)](https://www.npmjs.com/package/dochub?activeTab=dependents)
4
+ [![install size](https://packagephobia.com/badge?p=dochub)](https://packagephobia.com/result?p=dochub)
5
+ [![Downloads](https://badgen.net/npm/dt/dochub)](https://www.npmjs.com/package/dochub)
6
+ [![NPM Version](https://img.shields.io/npm/v/code-example.svg)](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
- - This command will create the necessary folder structure and configuration files.
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.
package/index.js CHANGED
@@ -1,4 +1,4 @@
1
- #!/usr/bin/env node
1
+ #!/usr/bin/env node
2
2
 
3
3
  const yargs = require('yargs');
4
4
  const initProject = require('./src/init');
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "dochub",
3
- "version": "1.0.0",
3
+ "version": "1.0.2",
4
4
  "main": "index.js",
5
5
  "scripts": {
6
6
  "test": "echo \"Error: no test specified\" && exit 1"
package/src/init.js CHANGED
@@ -152,6 +152,7 @@ function initializeNpm(projectPath) {
152
152
  start: 'node server.js'
153
153
  },
154
154
  keywords: [],
155
+ "main": "server.js",
155
156
  author: '',
156
157
  license: 'ISC'
157
158
  };
@@ -36,7 +36,7 @@ The project structure includes:
36
36
 
37
37
  ## Getting Help
38
38
 
39
- If you encounter any issues or have questions about using this documentation project, feel free to reach out via [GitHub Issues](https://github.com/your-repo/issues).
39
+ If you encounter any issues or have questions about using this documentation project, feel free to reach out via [GitHub Issues](https://github.com/tyler-Github/dochub/issues).
40
40
 
41
41
  ## License
42
42