@chronoter/main 0.1.0 → 0.1.3
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 +2 -117
- package/README.npm.md +2 -117
- package/dist/cli.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,118 +1,3 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @chronoter/main
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
## Features
|
|
6
|
-
|
|
7
|
-
- **MDX Support** - Write documentation using MDX (Markdown + JSX)
|
|
8
|
-
- **Development Server** - Fast development server powered by Vite
|
|
9
|
-
- **Hot Module Replacement** - Instant updates without page reload
|
|
10
|
-
- **React Components** - Use React components in your documentation
|
|
11
|
-
- **Tailwind CSS** - Styled with Tailwind CSS out of the box
|
|
12
|
-
|
|
13
|
-
## Installation
|
|
14
|
-
|
|
15
|
-
```bash
|
|
16
|
-
npm install -g chronoter
|
|
17
|
-
# or
|
|
18
|
-
yarn global add chronoter
|
|
19
|
-
# or
|
|
20
|
-
pnpm add -g chronoter
|
|
21
|
-
```
|
|
22
|
-
|
|
23
|
-
Or use it locally in your project:
|
|
24
|
-
|
|
25
|
-
```bash
|
|
26
|
-
npm install chronoter --save-dev
|
|
27
|
-
```
|
|
28
|
-
|
|
29
|
-
## Quick Start
|
|
30
|
-
|
|
31
|
-
1. Create a project directory with your MDX files:
|
|
32
|
-
|
|
33
|
-
```
|
|
34
|
-
my-docs/
|
|
35
|
-
├── chronoter.config.json # Optional configuration
|
|
36
|
-
└── docs/
|
|
37
|
-
├── index.mdx
|
|
38
|
-
└── getting-started.mdx
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
2. Start the development server:
|
|
42
|
-
|
|
43
|
-
```bash
|
|
44
|
-
chronoter dev
|
|
45
|
-
```
|
|
46
|
-
|
|
47
|
-
3. Open your browser at `http://localhost:3000`
|
|
48
|
-
|
|
49
|
-
## Usage
|
|
50
|
-
|
|
51
|
-
### Development Server
|
|
52
|
-
|
|
53
|
-
Start the development server with HMR:
|
|
54
|
-
|
|
55
|
-
```bash
|
|
56
|
-
chronoter dev [options]
|
|
57
|
-
```
|
|
58
|
-
|
|
59
|
-
#### Options
|
|
60
|
-
|
|
61
|
-
| Option | Description | Default |
|
|
62
|
-
|--------|-------------|---------|
|
|
63
|
-
| `-p, --port <port>` | Server port number | `3000` |
|
|
64
|
-
| `-H, --host <host>` | Server host | `localhost` |
|
|
65
|
-
| `--no-open` | Disable automatic browser opening | Browser opens by default |
|
|
66
|
-
| `--cwd <path>` | Working directory | Current directory |
|
|
67
|
-
|
|
68
|
-
#### Examples
|
|
69
|
-
|
|
70
|
-
```bash
|
|
71
|
-
# Start on port 8080
|
|
72
|
-
chronoter dev --port 8080
|
|
73
|
-
|
|
74
|
-
# Start without opening browser
|
|
75
|
-
chronoter dev --no-open
|
|
76
|
-
|
|
77
|
-
# Start in a specific directory
|
|
78
|
-
chronoter dev --cwd ./my-docs
|
|
79
|
-
```
|
|
80
|
-
|
|
81
|
-
## Configuration
|
|
82
|
-
|
|
83
|
-
Create a `chronoter.config.json` file in your project root:
|
|
84
|
-
|
|
85
|
-
```json
|
|
86
|
-
{
|
|
87
|
-
"site": {
|
|
88
|
-
"title": "My Documentation",
|
|
89
|
-
"description": "Documentation for my project"
|
|
90
|
-
},
|
|
91
|
-
"docsDir": "docs"
|
|
92
|
-
}
|
|
93
|
-
```
|
|
94
|
-
|
|
95
|
-
## MDX Files
|
|
96
|
-
|
|
97
|
-
Write your documentation in MDX format:
|
|
98
|
-
|
|
99
|
-
```mdx
|
|
100
|
-
---
|
|
101
|
-
title: Getting Started
|
|
102
|
-
---
|
|
103
|
-
|
|
104
|
-
# Welcome to My Documentation
|
|
105
|
-
|
|
106
|
-
This is written in **MDX**, so you can use React components:
|
|
107
|
-
|
|
108
|
-
<MyComponent />
|
|
109
|
-
```
|
|
110
|
-
|
|
111
|
-
## Requirements
|
|
112
|
-
|
|
113
|
-
- Node.js 18.0 or higher
|
|
114
|
-
|
|
115
|
-
## License
|
|
116
|
-
|
|
117
|
-
This software is proprietary. All rights reserved.
|
|
118
|
-
Commercial use is prohibited without explicit permission from the author.
|
|
3
|
+
The core implementation for Chronoter. See [chronoter](https://www.npmjs.com/package/chronoter) for documentation.
|
package/README.npm.md
CHANGED
|
@@ -1,118 +1,3 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @chronoter/main
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
## Features
|
|
6
|
-
|
|
7
|
-
- **MDX Support** - Write documentation using MDX (Markdown + JSX)
|
|
8
|
-
- **Development Server** - Fast development server powered by Vite
|
|
9
|
-
- **Hot Module Replacement** - Instant updates without page reload
|
|
10
|
-
- **React Components** - Use React components in your documentation
|
|
11
|
-
- **Tailwind CSS** - Styled with Tailwind CSS out of the box
|
|
12
|
-
|
|
13
|
-
## Installation
|
|
14
|
-
|
|
15
|
-
```bash
|
|
16
|
-
npm install -g chronoter
|
|
17
|
-
# or
|
|
18
|
-
yarn global add chronoter
|
|
19
|
-
# or
|
|
20
|
-
pnpm add -g chronoter
|
|
21
|
-
```
|
|
22
|
-
|
|
23
|
-
Or use it locally in your project:
|
|
24
|
-
|
|
25
|
-
```bash
|
|
26
|
-
npm install chronoter --save-dev
|
|
27
|
-
```
|
|
28
|
-
|
|
29
|
-
## Quick Start
|
|
30
|
-
|
|
31
|
-
1. Create a project directory with your MDX files:
|
|
32
|
-
|
|
33
|
-
```
|
|
34
|
-
my-docs/
|
|
35
|
-
├── chronoter.config.json # Optional configuration
|
|
36
|
-
└── docs/
|
|
37
|
-
├── index.mdx
|
|
38
|
-
└── getting-started.mdx
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
2. Start the development server:
|
|
42
|
-
|
|
43
|
-
```bash
|
|
44
|
-
chronoter dev
|
|
45
|
-
```
|
|
46
|
-
|
|
47
|
-
3. Open your browser at `http://localhost:3000`
|
|
48
|
-
|
|
49
|
-
## Usage
|
|
50
|
-
|
|
51
|
-
### Development Server
|
|
52
|
-
|
|
53
|
-
Start the development server with HMR:
|
|
54
|
-
|
|
55
|
-
```bash
|
|
56
|
-
chronoter dev [options]
|
|
57
|
-
```
|
|
58
|
-
|
|
59
|
-
#### Options
|
|
60
|
-
|
|
61
|
-
| Option | Description | Default |
|
|
62
|
-
|--------|-------------|---------|
|
|
63
|
-
| `-p, --port <port>` | Server port number | `3000` |
|
|
64
|
-
| `-H, --host <host>` | Server host | `localhost` |
|
|
65
|
-
| `--no-open` | Disable automatic browser opening | Browser opens by default |
|
|
66
|
-
| `--cwd <path>` | Working directory | Current directory |
|
|
67
|
-
|
|
68
|
-
#### Examples
|
|
69
|
-
|
|
70
|
-
```bash
|
|
71
|
-
# Start on port 8080
|
|
72
|
-
chronoter dev --port 8080
|
|
73
|
-
|
|
74
|
-
# Start without opening browser
|
|
75
|
-
chronoter dev --no-open
|
|
76
|
-
|
|
77
|
-
# Start in a specific directory
|
|
78
|
-
chronoter dev --cwd ./my-docs
|
|
79
|
-
```
|
|
80
|
-
|
|
81
|
-
## Configuration
|
|
82
|
-
|
|
83
|
-
Create a `chronoter.config.json` file in your project root:
|
|
84
|
-
|
|
85
|
-
```json
|
|
86
|
-
{
|
|
87
|
-
"site": {
|
|
88
|
-
"title": "My Documentation",
|
|
89
|
-
"description": "Documentation for my project"
|
|
90
|
-
},
|
|
91
|
-
"docsDir": "docs"
|
|
92
|
-
}
|
|
93
|
-
```
|
|
94
|
-
|
|
95
|
-
## MDX Files
|
|
96
|
-
|
|
97
|
-
Write your documentation in MDX format:
|
|
98
|
-
|
|
99
|
-
```mdx
|
|
100
|
-
---
|
|
101
|
-
title: Getting Started
|
|
102
|
-
---
|
|
103
|
-
|
|
104
|
-
# Welcome to My Documentation
|
|
105
|
-
|
|
106
|
-
This is written in **MDX**, so you can use React components:
|
|
107
|
-
|
|
108
|
-
<MyComponent />
|
|
109
|
-
```
|
|
110
|
-
|
|
111
|
-
## Requirements
|
|
112
|
-
|
|
113
|
-
- Node.js 18.0 or higher
|
|
114
|
-
|
|
115
|
-
## License
|
|
116
|
-
|
|
117
|
-
This software is proprietary. All rights reserved.
|
|
118
|
-
Commercial use is prohibited without explicit permission from the author.
|
|
3
|
+
The core implementation for Chronoter. See [chronoter](https://www.npmjs.com/package/chronoter) for documentation.
|
package/dist/cli.js
CHANGED
|
@@ -1633,7 +1633,7 @@ var runVersionCheck = async (packageName, currentVersion) => {
|
|
|
1633
1633
|
}
|
|
1634
1634
|
};
|
|
1635
1635
|
var PACKAGE_NAME = "chronoter";
|
|
1636
|
-
var CURRENT_VERSION = "0.1.
|
|
1636
|
+
var CURRENT_VERSION = "0.1.3";
|
|
1637
1637
|
var createCliProgram = () => {
|
|
1638
1638
|
const program = new Command();
|
|
1639
1639
|
program.name("chronoter").description("Chronoter - MDX-based documentation site generator").version(CURRENT_VERSION);
|