create-markdown 0.1.0 → 0.1.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 +40 -0
- package/dist/index.cjs +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/package.json +23 -11
package/README.md
CHANGED
|
@@ -1,7 +1,12 @@
|
|
|
1
1
|
# create-markdown
|
|
2
2
|
|
|
3
|
+
[](https://www.npmjs.com/package/create-markdown)
|
|
4
|
+
[](https://opensource.org/licenses/MIT)
|
|
5
|
+
|
|
3
6
|
Markdown package to enable creating markdown interfaces seamlessly because it is complicated and annoying asf.
|
|
4
7
|
|
|
8
|
+
📦 **[View on npm](https://www.npmjs.com/package/create-markdown)**
|
|
9
|
+
|
|
5
10
|
## Installation
|
|
6
11
|
|
|
7
12
|
```bash
|
|
@@ -29,6 +34,15 @@ const doc = createMarkdown('# Hello World');
|
|
|
29
34
|
console.log(doc.content);
|
|
30
35
|
```
|
|
31
36
|
|
|
37
|
+
### Default Export
|
|
38
|
+
|
|
39
|
+
```typescript
|
|
40
|
+
import createMarkdown from 'create-markdown';
|
|
41
|
+
|
|
42
|
+
const doc = createMarkdown('# Hello World');
|
|
43
|
+
console.log(doc.content);
|
|
44
|
+
```
|
|
45
|
+
|
|
32
46
|
### CommonJS
|
|
33
47
|
|
|
34
48
|
```javascript
|
|
@@ -67,6 +81,16 @@ Creates a new markdown document.
|
|
|
67
81
|
- `content` (string): Raw markdown content
|
|
68
82
|
- `meta` (Record<string, unknown>): Document metadata
|
|
69
83
|
|
|
84
|
+
### `VERSION`
|
|
85
|
+
|
|
86
|
+
Package version string.
|
|
87
|
+
|
|
88
|
+
```typescript
|
|
89
|
+
import { VERSION } from 'create-markdown';
|
|
90
|
+
|
|
91
|
+
console.log(VERSION); // '0.1.1'
|
|
92
|
+
```
|
|
93
|
+
|
|
70
94
|
## Development
|
|
71
95
|
|
|
72
96
|
```bash
|
|
@@ -81,8 +105,24 @@ bun run dev
|
|
|
81
105
|
|
|
82
106
|
# Clean build artifacts
|
|
83
107
|
bun run clean
|
|
108
|
+
|
|
109
|
+
# Run the playground
|
|
110
|
+
bun run playground
|
|
84
111
|
```
|
|
85
112
|
|
|
113
|
+
## Requirements
|
|
114
|
+
|
|
115
|
+
- Node.js 20+
|
|
116
|
+
- Bun 1.0+ (for development)
|
|
117
|
+
|
|
118
|
+
## Contributing
|
|
119
|
+
|
|
120
|
+
We welcome contributions! Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines.
|
|
121
|
+
|
|
122
|
+
## Changelog
|
|
123
|
+
|
|
124
|
+
See [CHANGELOG.md](./CHANGELOG.md) for release history.
|
|
125
|
+
|
|
86
126
|
## License
|
|
87
127
|
|
|
88
128
|
MIT
|
package/dist/index.cjs
CHANGED
package/dist/index.d.ts
CHANGED
|
@@ -30,6 +30,6 @@ export declare function createMarkdown(content?: string, options?: MarkdownOptio
|
|
|
30
30
|
/**
|
|
31
31
|
* Package version
|
|
32
32
|
*/
|
|
33
|
-
export declare const VERSION = "0.1.
|
|
33
|
+
export declare const VERSION = "0.1.1";
|
|
34
34
|
export default createMarkdown;
|
|
35
35
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.js
CHANGED
package/package.json
CHANGED
|
@@ -1,7 +1,23 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "create-markdown",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
|
+
"author": "Val Alexander <val@viewdue.ai>",
|
|
5
|
+
"repository": {
|
|
6
|
+
"type": "git",
|
|
7
|
+
"url": "https://github.com/BunsDev/create-markdown"
|
|
8
|
+
},
|
|
9
|
+
"homepage": "https://github.com/BunsDev/create-markdown",
|
|
10
|
+
"bugs": {
|
|
11
|
+
"url": "https://github.com/BunsDev/create-markdown/issues"
|
|
12
|
+
},
|
|
4
13
|
"description": "Minimal markdown package for creating and manipulating markdown content",
|
|
14
|
+
"license": "MIT",
|
|
15
|
+
"keywords": [
|
|
16
|
+
"markdown",
|
|
17
|
+
"md",
|
|
18
|
+
"bun",
|
|
19
|
+
"typescript"
|
|
20
|
+
],
|
|
5
21
|
"type": "module",
|
|
6
22
|
"main": "./dist/index.cjs",
|
|
7
23
|
"module": "./dist/index.js",
|
|
@@ -28,21 +44,17 @@
|
|
|
28
44
|
"build:types": "tsc --emitDeclarationOnly --declaration --outDir dist",
|
|
29
45
|
"dev": "bun run --watch src/index.ts",
|
|
30
46
|
"clean": "rm -rf dist",
|
|
31
|
-
"
|
|
47
|
+
"prepublish": "bun run clean && bun run build",
|
|
48
|
+
"publish": "bun publish --access public",
|
|
49
|
+
"deploy": "./deploy.sh",
|
|
50
|
+
"playground": "bun run build && cd playground && bun dev",
|
|
51
|
+
"playground:install": "cd playground && bun install"
|
|
32
52
|
},
|
|
33
|
-
"keywords": [
|
|
34
|
-
"markdown",
|
|
35
|
-
"md",
|
|
36
|
-
"bun",
|
|
37
|
-
"typescript"
|
|
38
|
-
],
|
|
39
|
-
"author": "",
|
|
40
|
-
"license": "MIT",
|
|
41
53
|
"devDependencies": {
|
|
42
54
|
"typescript": "^5.3.0"
|
|
43
55
|
},
|
|
44
56
|
"engines": {
|
|
45
|
-
"node": ">=
|
|
57
|
+
"node": ">=20.0.0"
|
|
46
58
|
},
|
|
47
59
|
"packageManager": "bun@1.0.0"
|
|
48
60
|
}
|