create-mordoc-app 0.0.3 → 0.0.4

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.
Files changed (2) hide show
  1. package/README.md +5 -52
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # create-mordoc-app
2
2
 
3
- Create Mordoc documentation sites with a single command.
3
+ Create documentation sites powered by [Mordoc](https://www.mordoc.dev/) with a single command.
4
4
 
5
5
  ## Usage
6
6
 
@@ -10,57 +10,10 @@ npx create-mordoc-app my-docs
10
10
 
11
11
  This will create a new Mordoc documentation site in a directory called `my-docs`.
12
12
 
13
+ ## License
13
14
 
14
- ## Examples
15
-
16
- ### Create a new project
17
-
18
- ```bash
19
- npx create-mordoc-app my-docs
20
- ```
21
-
22
- ### Create a new project without installing dependencies
23
-
24
- ```bash
25
- npx create-mordoc-app my-docs --skip-install
26
- ```
27
-
28
- ### Create a new project with git initialization
29
-
30
- ```bash
31
- npx create-mordoc-app my-docs --git
32
- ```
33
-
34
- ## What's included
35
-
36
- The generated project will have:
37
-
38
- - A `content` directory with sample markdown files
39
- - A `config` directory with site configuration
40
- - A minimal `package.json` with Mordoc as a dependency
41
- - Scripts for development and building
42
-
43
- ## Getting started after creation
44
-
45
- After creating your project:
46
-
47
- ```bash
48
- cd my-docs
49
- npm run dev
50
- ```
51
-
52
- This will start a development server at http://localhost:3000.
53
-
54
- To build your site for production:
55
-
56
- ```bash
57
- npm run build
58
- ```
59
-
60
- ## Requirements
61
-
62
- - Node.js 14 or later
15
+ MIT
63
16
 
64
- ## License
17
+ ## Mordoc Documentation
65
18
 
66
- MIT
19
+ Read the full docs [here](https://www.mordoc.dev/)
package/package.json CHANGED
@@ -4,7 +4,7 @@
4
4
  "type": "git",
5
5
  "url": "https://github.com/shiva-varanasi/create-mordoc-app.git"
6
6
  },
7
- "version": "0.0.3",
7
+ "version": "0.0.4",
8
8
  "description": "Create Mordoc documentation sites with one command",
9
9
  "main": "index.js",
10
10
  "bin": {
@@ -13,7 +13,7 @@
13
13
  "author": "Shiva Varanasi",
14
14
  "license": "MIT",
15
15
  "dependencies": {
16
- "mordoc": "^0.1.6"
16
+ "mordoc": "^0.1.7"
17
17
  },
18
18
  "engines": {
19
19
  "node": ">=18.0.0"