@stacksjs/bunpress 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/CHANGELOG.md +296 -0
- package/README.md +113 -26
- package/dist/bin/cli.js +2 -104
- package/dist/chunk-16hpnayn.js +505 -0
- package/dist/chunk-njjmvdjd.js +8 -0
- package/dist/chunk-nt1zw6bf.js +9632 -0
- package/dist/chunk-zabbw4a8.js +2 -0
- package/dist/config.d.ts +3 -5
- package/dist/robots.d.ts +5 -0
- package/dist/rss.d.ts +16 -0
- package/dist/serve.d.ts +8 -0
- package/dist/sitemap.d.ts +5 -0
- package/dist/src/index.js +1 -1
- package/dist/templates/blocks/alerts/caution.stx +9 -0
- package/dist/templates/blocks/alerts/important.stx +9 -0
- package/dist/templates/blocks/alerts/note.stx +9 -0
- package/dist/templates/blocks/alerts/tip.stx +9 -0
- package/dist/templates/blocks/alerts/warning.stx +9 -0
- package/dist/templates/blocks/containers/danger.stx +6 -0
- package/dist/templates/blocks/containers/details.stx +6 -0
- package/dist/templates/blocks/containers/info.stx +6 -0
- package/dist/templates/blocks/containers/raw.stx +3 -0
- package/dist/templates/blocks/containers/tip.stx +6 -0
- package/dist/templates/blocks/containers/warning.stx +6 -0
- package/dist/templates/blocks/inline/code.stx +1 -0
- package/dist/templates/blocks/inline/del.stx +1 -0
- package/dist/templates/blocks/inline/em.stx +1 -0
- package/dist/templates/blocks/inline/mark.stx +1 -0
- package/dist/templates/blocks/inline/strong.stx +1 -0
- package/dist/templates/blocks/inline/sub.stx +1 -0
- package/dist/templates/blocks/inline/sup.stx +1 -0
- package/dist/templates/features.stx +20 -0
- package/dist/templates/hero.stx +10 -0
- package/dist/templates/layout-doc.stx +157 -0
- package/dist/templates/layout-home.stx +23 -0
- package/dist/templates/page-toc.stx +267 -0
- package/dist/templates/sidebar-section.stx +42 -0
- package/dist/templates/sidebar.stx +54 -0
- package/dist/themes/bun/index.d.ts +34 -0
- package/dist/themes/index.d.ts +24 -0
- package/dist/themes/vitepress/base.css +549 -0
- package/dist/themes/vitepress/code-group.css +121 -0
- package/dist/themes/vitepress/custom-block.css +330 -0
- package/dist/themes/vitepress/index.d.ts +29 -0
- package/dist/themes/vitepress/index.ts +1963 -0
- package/dist/themes/vitepress/vars.css +436 -0
- package/dist/types.d.ts +85 -2
- package/package.json +30 -18
- package/dist/chunk-he6c5f4e.js +0 -1354
- package/dist/plugin.d.ts +0 -0
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,296 @@
|
|
|
1
|
+
[Compare changes](https://github.com/stacksjs/bunpress/compare/v0.1.0...v0.1.1)
|
|
2
|
+
|
|
3
|
+
### ๐ Bug Fixes
|
|
4
|
+
|
|
5
|
+
- remove duplicated toc ([ca5d37c](https://github.com/stacksjs/bunpress/commit/ca5d37c)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
6
|
+
|
|
7
|
+
### ๐งน Chores
|
|
8
|
+
|
|
9
|
+
- release v0.1.1 ([756d7c0](https://github.com/stacksjs/bunpress/commit/756d7c0)) _(by glennmichael123 <gtorregosa@gmail.com>)_
|
|
10
|
+
- wip ([a9c5a7c](https://github.com/stacksjs/bunpress/commit/a9c5a7c)) _(by glennmichael123 <gtorregosa@gmail.com>)_
|
|
11
|
+
- release v0.1.1 ([ad6f304](https://github.com/stacksjs/bunpress/commit/ad6f304)) _(by glennmichael123 <gtorregosa@gmail.com>)_
|
|
12
|
+
- wip ([077637d](https://github.com/stacksjs/bunpress/commit/077637d)) _(by glennmichael123 <gtorregosa@gmail.com>)_
|
|
13
|
+
- wip ([236df6c](https://github.com/stacksjs/bunpress/commit/236df6c)) _(by glennmichael123 <gtorregosa@gmail.com>)_
|
|
14
|
+
- wip ([8a6d50e](https://github.com/stacksjs/bunpress/commit/8a6d50e)) _(by glennmichael123 <gtorregosa@gmail.com>)_
|
|
15
|
+
- wip ([5716e08](https://github.com/stacksjs/bunpress/commit/5716e08)) _(by glennmichael123 <gtorregosa@gmail.com>)_
|
|
16
|
+
- wip ([2b730a7](https://github.com/stacksjs/bunpress/commit/2b730a7)) _(by glennmichael123 <gtorregosa@gmail.com>)_
|
|
17
|
+
- wip ([8076014](https://github.com/stacksjs/bunpress/commit/8076014)) _(by chrisbreuer <chrisbreuer93@gmail.com>)_
|
|
18
|
+
- wip ([0dd167e](https://github.com/stacksjs/bunpress/commit/0dd167e)) _(by chrisbreuer <chrisbreuer93@gmail.com>)_
|
|
19
|
+
- wip ([562d7a5](https://github.com/stacksjs/bunpress/commit/562d7a5)) _(by chrisbreuer <chrisbreuer93@gmail.com>)_
|
|
20
|
+
- **deps**: update actions/cache action to v5 (#34) ([0a359ac](https://github.com/stacksjs/bunpress/commit/0a359ac)) _(by [renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>](https://github.com/renovate[bot]))_ ([#34](https://github.com/stacksjs/bunpress/issues/34), [#34](https://github.com/stacksjs/bunpress/issues/34))
|
|
21
|
+
- **deps**: update actions/cache action to v5.0.3 (#37) ([2c88066](https://github.com/stacksjs/bunpress/commit/2c88066)) _(by [renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>](https://github.com/renovate[bot]))_ ([#37](https://github.com/stacksjs/bunpress/issues/37), [#37](https://github.com/stacksjs/bunpress/issues/37))
|
|
22
|
+
- **deps**: update actions/checkout action to v6 (#30) ([ef5d753](https://github.com/stacksjs/bunpress/commit/ef5d753)) _(by [renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>](https://github.com/renovate[bot]))_ ([#30](https://github.com/stacksjs/bunpress/issues/30), [#30](https://github.com/stacksjs/bunpress/issues/30))
|
|
23
|
+
- **deps**: update all non-major dependencies (#28) ([30f55b1](https://github.com/stacksjs/bunpress/commit/30f55b1)) _(by [renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>](https://github.com/renovate[bot]))_ ([#28](https://github.com/stacksjs/bunpress/issues/28), [#28](https://github.com/stacksjs/bunpress/issues/28))
|
|
24
|
+
- **deps**: update dependency actions/cache to v5.0.2 (#35) ([bdaa73e](https://github.com/stacksjs/bunpress/commit/bdaa73e)) _(by Chris <chrisbreuer93@gmail.com>)_ ([#35](https://github.com/stacksjs/bunpress/issues/35), [#35](https://github.com/stacksjs/bunpress/issues/35))
|
|
25
|
+
- **deps**: update dependency actions/checkout to v6.0.1 (#36) ([2d95197](https://github.com/stacksjs/bunpress/commit/2d95197)) _(by Chris <chrisbreuer93@gmail.com>)_ ([#36](https://github.com/stacksjs/bunpress/issues/36), [#36](https://github.com/stacksjs/bunpress/issues/36))
|
|
26
|
+
- wip ([15a67fd](https://github.com/stacksjs/bunpress/commit/15a67fd)) _(by Chris <chrisbreuer93@gmail.com>)_
|
|
27
|
+
- wip ([d170104](https://github.com/stacksjs/bunpress/commit/d170104)) _(by Chris <chrisbreuer93@gmail.com>)_
|
|
28
|
+
- wip ([948bef8](https://github.com/stacksjs/bunpress/commit/948bef8)) _(by Chris <chrisbreuer93@gmail.com>)_
|
|
29
|
+
- wip ([7b1491b](https://github.com/stacksjs/bunpress/commit/7b1491b)) _(by Chris <chrisbreuer93@gmail.com>)_
|
|
30
|
+
- wip ([797928f](https://github.com/stacksjs/bunpress/commit/797928f)) _(by Chris <chrisbreuer93@gmail.com>)_
|
|
31
|
+
- wip ([e60c502](https://github.com/stacksjs/bunpress/commit/e60c502)) _(by Chris <chrisbreuer93@gmail.com>)_
|
|
32
|
+
- wip ([b030902](https://github.com/stacksjs/bunpress/commit/b030902)) _(by Chris <chrisbreuer93@gmail.com>)_
|
|
33
|
+
- wip ([b957d19](https://github.com/stacksjs/bunpress/commit/b957d19)) _(by Chris <chrisbreuer93@gmail.com>)_
|
|
34
|
+
- wip ([7c04f57](https://github.com/stacksjs/bunpress/commit/7c04f57)) _(by Chris <chrisbreuer93@gmail.com>)_
|
|
35
|
+
- wip ([131654d](https://github.com/stacksjs/bunpress/commit/131654d)) _(by Chris <chrisbreuer93@gmail.com>)_
|
|
36
|
+
- wip ([ad1d9e3](https://github.com/stacksjs/bunpress/commit/ad1d9e3)) _(by Chris <chrisbreuer93@gmail.com>)_
|
|
37
|
+
- wip ([753b9a7](https://github.com/stacksjs/bunpress/commit/753b9a7)) _(by Chris <chrisbreuer93@gmail.com>)_
|
|
38
|
+
- wip ([9a07c3d](https://github.com/stacksjs/bunpress/commit/9a07c3d)) _(by Chris <chrisbreuer93@gmail.com>)_
|
|
39
|
+
- wip ([b2ce9e1](https://github.com/stacksjs/bunpress/commit/b2ce9e1)) _(by Chris <chrisbreuer93@gmail.com>)_
|
|
40
|
+
- wip ([d09d72b](https://github.com/stacksjs/bunpress/commit/d09d72b)) _(by Chris <chrisbreuer93@gmail.com>)_
|
|
41
|
+
- wip ([2d5285f](https://github.com/stacksjs/bunpress/commit/2d5285f)) _(by Chris <chrisbreuer93@gmail.com>)_
|
|
42
|
+
- wip ([29aa8f6](https://github.com/stacksjs/bunpress/commit/29aa8f6)) _(by Chris <chrisbreuer93@gmail.com>)_
|
|
43
|
+
- wip ([ed0304a](https://github.com/stacksjs/bunpress/commit/ed0304a)) _(by Chris <chrisbreuer93@gmail.com>)_
|
|
44
|
+
- wip ([bd6614f](https://github.com/stacksjs/bunpress/commit/bd6614f)) _(by Chris <chrisbreuer93@gmail.com>)_
|
|
45
|
+
- wip ([ba9ec5e](https://github.com/stacksjs/bunpress/commit/ba9ec5e)) _(by Chris <chrisbreuer93@gmail.com>)_
|
|
46
|
+
- wip ([f016e0f](https://github.com/stacksjs/bunpress/commit/f016e0f)) _(by Chris <chrisbreuer93@gmail.com>)_
|
|
47
|
+
- wip ([9cc564e](https://github.com/stacksjs/bunpress/commit/9cc564e)) _(by Chris <chrisbreuer93@gmail.com>)_
|
|
48
|
+
- wip ([70bd2d9](https://github.com/stacksjs/bunpress/commit/70bd2d9)) _(by Chris <chrisbreuer93@gmail.com>)_
|
|
49
|
+
- **deps**: update all non-major dependencies (#23) ([ac6b771](https://github.com/stacksjs/bunpress/commit/ac6b771)) _(by [renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>](https://github.com/renovate[bot]))_ ([#23](https://github.com/stacksjs/bunpress/issues/23), [#23](https://github.com/stacksjs/bunpress/issues/23))
|
|
50
|
+
- **deps**: update actions/checkout action to v5 (#7) ([941217e](https://github.com/stacksjs/bunpress/commit/941217e)) _(by [renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>](https://github.com/renovate[bot]))_ ([#7](https://github.com/stacksjs/bunpress/issues/7), [#7](https://github.com/stacksjs/bunpress/issues/7))
|
|
51
|
+
- **deps**: update dependency marked to v17 (#26) ([947b7d2](https://github.com/stacksjs/bunpress/commit/947b7d2)) _(by [renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>](https://github.com/renovate[bot]))_ ([#26](https://github.com/stacksjs/bunpress/issues/26), [#26](https://github.com/stacksjs/bunpress/issues/26))
|
|
52
|
+
- wip ([82dff3c](https://github.com/stacksjs/bunpress/commit/82dff3c)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
53
|
+
- wip ([023745b](https://github.com/stacksjs/bunpress/commit/023745b)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
54
|
+
- fix docs ([0675a90](https://github.com/stacksjs/bunpress/commit/0675a90)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
55
|
+
- wip ([5597e06](https://github.com/stacksjs/bunpress/commit/5597e06)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
56
|
+
- wip ([7cf4b6e](https://github.com/stacksjs/bunpress/commit/7cf4b6e)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
57
|
+
- update deploy ([44e86d1](https://github.com/stacksjs/bunpress/commit/44e86d1)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
58
|
+
- wip ([06c6a03](https://github.com/stacksjs/bunpress/commit/06c6a03)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
59
|
+
- wip ([5c1cd3c](https://github.com/stacksjs/bunpress/commit/5c1cd3c)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
60
|
+
- benchmarks ([dc11a9c](https://github.com/stacksjs/bunpress/commit/dc11a9c)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
61
|
+
- wip ([66b7888](https://github.com/stacksjs/bunpress/commit/66b7888)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
62
|
+
- add seo and sitemaps ([1563be7](https://github.com/stacksjs/bunpress/commit/1563be7)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
63
|
+
- add Fathom support ([5bd2e1b](https://github.com/stacksjs/bunpress/commit/5bd2e1b)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
64
|
+
- wip ([b90d2c7](https://github.com/stacksjs/bunpress/commit/b90d2c7)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
65
|
+
|
|
66
|
+
### ๐ Miscellaneous
|
|
67
|
+
|
|
68
|
+
- Revert "chore: release v0.1.1" ([746dbc6](https://github.com/stacksjs/bunpress/commit/746dbc6)) _(by glennmichael123 <gtorregosa@gmail.com>)_
|
|
69
|
+
|
|
70
|
+
### Contributors
|
|
71
|
+
|
|
72
|
+
- _Adelino Ngomacha <adelinob335@gmail.com>_
|
|
73
|
+
- _Chris <chrisbreuer93@gmail.com>_
|
|
74
|
+
- _[renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>](https://github.com/renovate[bot])_
|
|
75
|
+
- _chrisbreuer <chrisbreuer93@gmail.com>_
|
|
76
|
+
- _glennmichael123 <gtorregosa@gmail.com>_
|
|
77
|
+
|
|
78
|
+
[Compare changes](https://github.com/stacksjs/bunpress/compare/v0.0.5...v0.1.0)
|
|
79
|
+
|
|
80
|
+
### ๐ Features
|
|
81
|
+
|
|
82
|
+
- add TOC ([0410c9e](https://github.com/stacksjs/bunpress/commit/0410c9e)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
83
|
+
|
|
84
|
+
### ๐งน Chores
|
|
85
|
+
|
|
86
|
+
- release v0.1.0 ([863e50c](https://github.com/stacksjs/bunpress/commit/863e50c)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
87
|
+
- wip ([94df272](https://github.com/stacksjs/bunpress/commit/94df272)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
88
|
+
- wip ([092bdfd](https://github.com/stacksjs/bunpress/commit/092bdfd)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
89
|
+
- wip ([6c45604](https://github.com/stacksjs/bunpress/commit/6c45604)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
90
|
+
- wip ([49d6022](https://github.com/stacksjs/bunpress/commit/49d6022)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
91
|
+
- fix ui ([5af99b8](https://github.com/stacksjs/bunpress/commit/5af99b8)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
92
|
+
- fix code highlights ([259feed](https://github.com/stacksjs/bunpress/commit/259feed)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
93
|
+
- fix highlighter colors ([2fc59cd](https://github.com/stacksjs/bunpress/commit/2fc59cd)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
94
|
+
- wip ([c036a5d](https://github.com/stacksjs/bunpress/commit/c036a5d)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
95
|
+
- fix tests ([7437fe0](https://github.com/stacksjs/bunpress/commit/7437fe0)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
96
|
+
- wip ([a4a900f](https://github.com/stacksjs/bunpress/commit/a4a900f)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
97
|
+
- wip ([9d94486](https://github.com/stacksjs/bunpress/commit/9d94486)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
98
|
+
- wip ([e66ce1f](https://github.com/stacksjs/bunpress/commit/e66ce1f)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
99
|
+
- wip ([15acab4](https://github.com/stacksjs/bunpress/commit/15acab4)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
100
|
+
- wip ([b94e66a](https://github.com/stacksjs/bunpress/commit/b94e66a)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
101
|
+
- wip ([3ccbce1](https://github.com/stacksjs/bunpress/commit/3ccbce1)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
102
|
+
- update TOC ([6242ed2](https://github.com/stacksjs/bunpress/commit/6242ed2)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
103
|
+
- wip ([96cc9d6](https://github.com/stacksjs/bunpress/commit/96cc9d6)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
104
|
+
- wip ([5585f20](https://github.com/stacksjs/bunpress/commit/5585f20)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
105
|
+
- add emoji support ([e6570a2](https://github.com/stacksjs/bunpress/commit/e6570a2)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
106
|
+
- custom header anchor ([721629a](https://github.com/stacksjs/bunpress/commit/721629a)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
107
|
+
- wip ([5764b61](https://github.com/stacksjs/bunpress/commit/5764b61)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
108
|
+
- wip ([3ca64e6](https://github.com/stacksjs/bunpress/commit/3ca64e6)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
109
|
+
- wip ([1b23bc0](https://github.com/stacksjs/bunpress/commit/1b23bc0)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
110
|
+
- wip ([bd049e4](https://github.com/stacksjs/bunpress/commit/bd049e4)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
111
|
+
- wip ([a2bf48e](https://github.com/stacksjs/bunpress/commit/a2bf48e)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
112
|
+
- fix repeated log without update ([679ec06](https://github.com/stacksjs/bunpress/commit/679ec06)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
113
|
+
- wip ([b8fabef](https://github.com/stacksjs/bunpress/commit/b8fabef)) _(by Chris <chrisbreuer93@gmail.com>)_
|
|
114
|
+
- fix tables display ([8c525cb](https://github.com/stacksjs/bunpress/commit/8c525cb)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
115
|
+
- wip ([9f7bc78](https://github.com/stacksjs/bunpress/commit/9f7bc78)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
116
|
+
- wip ([6be6ea8](https://github.com/stacksjs/bunpress/commit/6be6ea8)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
117
|
+
- wip ([ca17a6b](https://github.com/stacksjs/bunpress/commit/ca17a6b)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
118
|
+
- improve ui ([ae8c823](https://github.com/stacksjs/bunpress/commit/ae8c823)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
119
|
+
- add sidebar ([f8bf9c8](https://github.com/stacksjs/bunpress/commit/f8bf9c8)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
120
|
+
- wip ([5f73a46](https://github.com/stacksjs/bunpress/commit/5f73a46)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
121
|
+
- wip ([db1a9c9](https://github.com/stacksjs/bunpress/commit/db1a9c9)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
122
|
+
- wip ([db48fc9](https://github.com/stacksjs/bunpress/commit/db48fc9)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
123
|
+
- wip ([60e9947](https://github.com/stacksjs/bunpress/commit/60e9947)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
124
|
+
- wip ([f3cd9e9](https://github.com/stacksjs/bunpress/commit/f3cd9e9)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
125
|
+
- wip ([4c8bf13](https://github.com/stacksjs/bunpress/commit/4c8bf13)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
|
|
126
|
+
|
|
127
|
+
### Contributors
|
|
128
|
+
|
|
129
|
+
- _Adelino Ngomacha <adelinob335@gmail.com>_
|
|
130
|
+
- _Chris <chrisbreuer93@gmail.com>_
|
|
131
|
+
|
|
132
|
+
[Compare changes](https://github.com/stacksjs/bunpress/compare/v0.0.4...v0.0.5)
|
|
133
|
+
|
|
134
|
+
### ๐งน Chores
|
|
135
|
+
|
|
136
|
+
- release v0.0.5 ([53b1a32](https://github.com/stacksjs/bunpress/commit/53b1a32))
|
|
137
|
+
- wip ([47221e5](https://github.com/stacksjs/bunpress/commit/47221e5))
|
|
138
|
+
|
|
139
|
+
### Contributors
|
|
140
|
+
|
|
141
|
+
- Chris <chrisbreuer93@gmail.com>
|
|
142
|
+
|
|
143
|
+
[Compare changes](https://github.com/stacksjs/bunpress/compare/v0.0.4...HEAD)
|
|
144
|
+
|
|
145
|
+
### ๐งน Chores
|
|
146
|
+
|
|
147
|
+
- wip ([47221e5](https://github.com/stacksjs/bunpress/commit/47221e5))
|
|
148
|
+
|
|
149
|
+
### Contributors
|
|
150
|
+
|
|
151
|
+
- Chris <chrisbreuer93@gmail.com>
|
|
152
|
+
|
|
153
|
+
[Compare changes](https://github.com/stacksjs/bunpress/compare/v0.0.3...v0.0.4)
|
|
154
|
+
|
|
155
|
+
### ๐งน Chores
|
|
156
|
+
|
|
157
|
+
- release v0.0.4 ([75a2aed](https://github.com/stacksjs/bunpress/commit/75a2aed))
|
|
158
|
+
- wip ([5e7fdc1](https://github.com/stacksjs/bunpress/commit/5e7fdc1))
|
|
159
|
+
|
|
160
|
+
### Contributors
|
|
161
|
+
|
|
162
|
+
- Chris <chrisbreuer93@gmail.com>
|
|
163
|
+
|
|
164
|
+
[Compare changes](https://github.com/stacksjs/bunpress/compare/v0.0.3...HEAD)
|
|
165
|
+
|
|
166
|
+
### ๐งน Chores
|
|
167
|
+
|
|
168
|
+
- wip ([5e7fdc1](https://github.com/stacksjs/bunpress/commit/5e7fdc1))
|
|
169
|
+
|
|
170
|
+
### Contributors
|
|
171
|
+
|
|
172
|
+
- Chris <chrisbreuer93@gmail.com>
|
|
173
|
+
|
|
174
|
+
[Compare changes](https://github.com/stacksjs/bunpress/compare/v0.0.2...v0.0.3)
|
|
175
|
+
|
|
176
|
+
### ๐งน Chores
|
|
177
|
+
|
|
178
|
+
- release v0.0.3 ([ddea0ca](https://github.com/stacksjs/bunpress/commit/ddea0ca))
|
|
179
|
+
- wip ([7949427](https://github.com/stacksjs/bunpress/commit/7949427))
|
|
180
|
+
|
|
181
|
+
### Contributors
|
|
182
|
+
|
|
183
|
+
- Chris <chrisbreuer93@gmail.com>
|
|
184
|
+
|
|
185
|
+
[Compare changes](https://github.com/stacksjs/bunpress/compare/v0.0.2...HEAD)
|
|
186
|
+
|
|
187
|
+
### ๐งน Chores
|
|
188
|
+
|
|
189
|
+
- wip ([7949427](https://github.com/stacksjs/bunpress/commit/7949427))
|
|
190
|
+
|
|
191
|
+
### Contributors
|
|
192
|
+
|
|
193
|
+
- Chris <chrisbreuer93@gmail.com>
|
|
194
|
+
|
|
195
|
+
[Compare changes](https://github.com/stacksjs/bunpress/compare/v0.0.2...HEAD)
|
|
196
|
+
|
|
197
|
+
### ๐งน Chores
|
|
198
|
+
|
|
199
|
+
- wip ([7949427](https://github.com/stacksjs/bunpress/commit/7949427))
|
|
200
|
+
|
|
201
|
+
### Contributors
|
|
202
|
+
|
|
203
|
+
- Chris <chrisbreuer93@gmail.com>
|
|
204
|
+
|
|
205
|
+
[Compare changes](https://github.com/stacksjs/bunpress/compare/v0.0.1...v0.0.2)
|
|
206
|
+
|
|
207
|
+
### ๐งน Chores
|
|
208
|
+
|
|
209
|
+
- release v0.0.2 ([4f0321b](https://github.com/stacksjs/bunpress/commit/4f0321b))
|
|
210
|
+
- wip ([d4bf5e6](https://github.com/stacksjs/bunpress/commit/d4bf5e6))
|
|
211
|
+
|
|
212
|
+
### Contributors
|
|
213
|
+
|
|
214
|
+
- Chris <chrisbreuer93@gmail.com>
|
|
215
|
+
|
|
216
|
+
[Compare changes](https://github.com/stacksjs/bunpress/compare/v0.0.1...HEAD)
|
|
217
|
+
|
|
218
|
+
### ๐งน Chores
|
|
219
|
+
|
|
220
|
+
- wip ([d4bf5e6](https://github.com/stacksjs/bunpress/commit/d4bf5e6))
|
|
221
|
+
|
|
222
|
+
### Contributors
|
|
223
|
+
|
|
224
|
+
- Chris <chrisbreuer93@gmail.com>
|
|
225
|
+
|
|
226
|
+
### ๐งน Chores
|
|
227
|
+
|
|
228
|
+
- wip ([61e4668](https://github.com/stacksjs/bunpress/commit/61e4668))
|
|
229
|
+
- wip ([9930a69](https://github.com/stacksjs/bunpress/commit/9930a69))
|
|
230
|
+
- wip ([2be4148](https://github.com/stacksjs/bunpress/commit/2be4148))
|
|
231
|
+
- wip ([a3a59b2](https://github.com/stacksjs/bunpress/commit/a3a59b2))
|
|
232
|
+
- wip ([98a148b](https://github.com/stacksjs/bunpress/commit/98a148b))
|
|
233
|
+
- wip ([4dc4a55](https://github.com/stacksjs/bunpress/commit/4dc4a55))
|
|
234
|
+
- wip ([77cbeca](https://github.com/stacksjs/bunpress/commit/77cbeca))
|
|
235
|
+
- wip ([0d1152b](https://github.com/stacksjs/bunpress/commit/0d1152b))
|
|
236
|
+
- add back bunfig only config ([e72ddd0](https://github.com/stacksjs/bunpress/commit/e72ddd0))
|
|
237
|
+
- wip ([5b2ad3e](https://github.com/stacksjs/bunpress/commit/5b2ad3e))
|
|
238
|
+
- wip ([86b6f4b](https://github.com/stacksjs/bunpress/commit/86b6f4b))
|
|
239
|
+
- wip ([67665a4](https://github.com/stacksjs/bunpress/commit/67665a4))
|
|
240
|
+
- layout sizing ([b4f02d3](https://github.com/stacksjs/bunpress/commit/b4f02d3))
|
|
241
|
+
- wip ([891ff6c](https://github.com/stacksjs/bunpress/commit/891ff6c))
|
|
242
|
+
- wip ([c158f50](https://github.com/stacksjs/bunpress/commit/c158f50))
|
|
243
|
+
- wip ([d94ac88](https://github.com/stacksjs/bunpress/commit/d94ac88))
|
|
244
|
+
- wip ([76e9fc0](https://github.com/stacksjs/bunpress/commit/76e9fc0))
|
|
245
|
+
- wip ([6060f21](https://github.com/stacksjs/bunpress/commit/6060f21))
|
|
246
|
+
- wip ([073b61e](https://github.com/stacksjs/bunpress/commit/073b61e))
|
|
247
|
+
- wip ([7cb2584](https://github.com/stacksjs/bunpress/commit/7cb2584))
|
|
248
|
+
- wip ([00f7d6e](https://github.com/stacksjs/bunpress/commit/00f7d6e))
|
|
249
|
+
- wip ([56181a5](https://github.com/stacksjs/bunpress/commit/56181a5))
|
|
250
|
+
- wip ([7085b18](https://github.com/stacksjs/bunpress/commit/7085b18))
|
|
251
|
+
- wip ([fc93791](https://github.com/stacksjs/bunpress/commit/fc93791))
|
|
252
|
+
- wip ([15b374a](https://github.com/stacksjs/bunpress/commit/15b374a))
|
|
253
|
+
- wip sitemap ([03a7323](https://github.com/stacksjs/bunpress/commit/03a7323))
|
|
254
|
+
- wip data-loading ([ee6d2f3](https://github.com/stacksjs/bunpress/commit/ee6d2f3))
|
|
255
|
+
- theme config ([6ef111e](https://github.com/stacksjs/bunpress/commit/6ef111e))
|
|
256
|
+
- add syntax highlight ([75573d3](https://github.com/stacksjs/bunpress/commit/75573d3))
|
|
257
|
+
- add table of content ([16beeca](https://github.com/stacksjs/bunpress/commit/16beeca))
|
|
258
|
+
- update markdown-extensions tests ([c64e1a3](https://github.com/stacksjs/bunpress/commit/c64e1a3))
|
|
259
|
+
- wip ([a0d0fd1](https://github.com/stacksjs/bunpress/commit/a0d0fd1))
|
|
260
|
+
- wip ([00d5467](https://github.com/stacksjs/bunpress/commit/00d5467))
|
|
261
|
+
- wip ([80cf806](https://github.com/stacksjs/bunpress/commit/80cf806))
|
|
262
|
+
- wip ([2826e2e](https://github.com/stacksjs/bunpress/commit/2826e2e))
|
|
263
|
+
- wip ([1d04b95](https://github.com/stacksjs/bunpress/commit/1d04b95))
|
|
264
|
+
- wip ([caef2f5](https://github.com/stacksjs/bunpress/commit/caef2f5))
|
|
265
|
+
- wip ([63f0c6f](https://github.com/stacksjs/bunpress/commit/63f0c6f))
|
|
266
|
+
- wip ([792e9b8](https://github.com/stacksjs/bunpress/commit/792e9b8))
|
|
267
|
+
- wip ([27bfb68](https://github.com/stacksjs/bunpress/commit/27bfb68))
|
|
268
|
+
- wip ([ed2ebb4](https://github.com/stacksjs/bunpress/commit/ed2ebb4))
|
|
269
|
+
- wip ([35ad008](https://github.com/stacksjs/bunpress/commit/35ad008))
|
|
270
|
+
- wip ([5a5bba5](https://github.com/stacksjs/bunpress/commit/5a5bba5))
|
|
271
|
+
- update tools ([25f8294](https://github.com/stacksjs/bunpress/commit/25f8294))
|
|
272
|
+
- update tools ([59c37aa](https://github.com/stacksjs/bunpress/commit/59c37aa))
|
|
273
|
+
- wip ([b34609c](https://github.com/stacksjs/bunpress/commit/b34609c))
|
|
274
|
+
- wip ([89b7506](https://github.com/stacksjs/bunpress/commit/89b7506))
|
|
275
|
+
- wip ([e4036a6](https://github.com/stacksjs/bunpress/commit/e4036a6))
|
|
276
|
+
- wip ([f121855](https://github.com/stacksjs/bunpress/commit/f121855))
|
|
277
|
+
- wip ([103157a](https://github.com/stacksjs/bunpress/commit/103157a))
|
|
278
|
+
- wip ([ffa7cf4](https://github.com/stacksjs/bunpress/commit/ffa7cf4))
|
|
279
|
+
- wip ([672817e](https://github.com/stacksjs/bunpress/commit/672817e))
|
|
280
|
+
- wip ([f6ebd66](https://github.com/stacksjs/bunpress/commit/f6ebd66))
|
|
281
|
+
- wip ([b171f9b](https://github.com/stacksjs/bunpress/commit/b171f9b))
|
|
282
|
+
- **deps**: update dependency bunfig to ^0.8.3 (#3) ([ea0ba58](https://github.com/stacksjs/bunpress/commit/ea0ba58)) ([#3](https://github.com/stacksjs/bunpress/issues/3), [#3](https://github.com/stacksjs/bunpress/issues/3))
|
|
283
|
+
- wip ([01689e6](https://github.com/stacksjs/bunpress/commit/01689e6))
|
|
284
|
+
- wip ([0f2584c](https://github.com/stacksjs/bunpress/commit/0f2584c))
|
|
285
|
+
- wip ([9d12b4a](https://github.com/stacksjs/bunpress/commit/9d12b4a))
|
|
286
|
+
- **deps**: update all non-major dependencies (#2) ([f2d9114](https://github.com/stacksjs/bunpress/commit/f2d9114)) ([#2](https://github.com/stacksjs/bunpress/issues/2), [#2](https://github.com/stacksjs/bunpress/issues/2))
|
|
287
|
+
- wip ([add83ac](https://github.com/stacksjs/bunpress/commit/add83ac))
|
|
288
|
+
- wip ([c7bbd09](https://github.com/stacksjs/bunpress/commit/c7bbd09))
|
|
289
|
+
- wip ([1d3baf1](https://github.com/stacksjs/bunpress/commit/1d3baf1))
|
|
290
|
+
- initial commit ([94b7977](https://github.com/stacksjs/bunpress/commit/94b7977))
|
|
291
|
+
|
|
292
|
+
### Contributors
|
|
293
|
+
|
|
294
|
+
- Adelino Ngomacha <adelinob335@gmail.com>
|
|
295
|
+
- Chris <chrisbreuer93@gmail.com>
|
|
296
|
+
- renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
|
package/README.md
CHANGED
|
@@ -14,16 +14,31 @@ BunPress is a lightning-fast static site generator designed specifically for doc
|
|
|
14
14
|
|
|
15
15
|
## Features
|
|
16
16
|
|
|
17
|
-
|
|
18
|
-
-
|
|
19
|
-
-
|
|
20
|
-
-
|
|
21
|
-
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
-
|
|
25
|
-
- ๐ **
|
|
26
|
-
-
|
|
17
|
+
### Core Features
|
|
18
|
+
- โก **Lightning Fast** - 0.18s build time (4,000 files), 11x faster than Eleventy
|
|
19
|
+
- ๐ **Rich Markdown** - VitePress-compatible markdown with containers, alerts, code groups, and syntax highlighting
|
|
20
|
+
- ๐ **Smart TOC** - Automatic table of contents with filtering, positioning (sidebar/inline/floating), and interactive navigation
|
|
21
|
+
- ๐ ๏ธ **Developer Friendly** - Native TypeScript support, comprehensive CLI (15+ commands), and extensive customization
|
|
22
|
+
|
|
23
|
+
### SEO & Analytics
|
|
24
|
+
- ๐ **Complete SEO** - Auto-generated sitemap.xml, robots.txt, Open Graph tags, and JSON-LD structured data
|
|
25
|
+
- ๐ **Fathom Analytics** - Privacy-focused analytics with GDPR/CCPA compliance and DNT support
|
|
26
|
+
- ๐ **SEO Validation** - Built-in SEO checker with auto-fix mode for common issues
|
|
27
|
+
|
|
28
|
+
### Markdown Extensions (VitePress-Compatible)
|
|
29
|
+
- โ
Custom containers (info, tip, warning, danger, details, raw)
|
|
30
|
+
- โ
GitHub-flavored alerts (note, tip, important, warning, caution)
|
|
31
|
+
- โ
Code features (line highlighting, line numbers, focus, diffs, errors/warnings, groups)
|
|
32
|
+
- โ
Code imports from files with line ranges and regions
|
|
33
|
+
- โ
Tables with alignment and formatting
|
|
34
|
+
- โ
Image enhancements with captions and lazy loading
|
|
35
|
+
- โ
Custom header anchors and inline TOC
|
|
36
|
+
|
|
37
|
+
### Developer Experience
|
|
38
|
+
- ๐ **Fast Dev Server** - ~100ms startup, hot reload, and instant feedback
|
|
39
|
+
- ๐ฆ **Small Bundles** - ~45KB per page (HTML + JS + CSS)
|
|
40
|
+
- ๐ **Low Memory** - ~50MB dev server, ~250MB peak for 1000 files
|
|
41
|
+
- ๐ฏ **15+ CLI Commands** - Build, dev, preview, stats, doctor, SEO check, and more
|
|
27
42
|
|
|
28
43
|
## Quick Start
|
|
29
44
|
|
|
@@ -72,30 +87,102 @@ Configure your site in `bunpress.config.ts`:
|
|
|
72
87
|
|
|
73
88
|
```typescript
|
|
74
89
|
export default {
|
|
90
|
+
title: 'My Documentation',
|
|
91
|
+
description: 'Built with BunPress',
|
|
75
92
|
nav: [
|
|
76
93
|
{ text: 'Home', link: '/' },
|
|
77
94
|
{ text: 'Guide', link: '/guide' },
|
|
78
95
|
{ text: 'API', link: '/api' }
|
|
79
96
|
],
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
97
|
+
|
|
98
|
+
// SEO Configuration
|
|
99
|
+
sitemap: {
|
|
100
|
+
enabled: true,
|
|
101
|
+
baseUrl: 'https://mysite.com',
|
|
102
|
+
},
|
|
103
|
+
robots: {
|
|
104
|
+
enabled: true,
|
|
105
|
+
},
|
|
106
|
+
|
|
107
|
+
// Analytics
|
|
108
|
+
fathom: {
|
|
109
|
+
enabled: true,
|
|
110
|
+
siteId: 'YOUR_SITE_ID',
|
|
111
|
+
honorDNT: true,
|
|
112
|
+
},
|
|
87
113
|
}
|
|
88
114
|
```
|
|
89
115
|
|
|
116
|
+
## CLI Commands
|
|
117
|
+
|
|
118
|
+
BunPress provides a comprehensive CLI for managing your documentation:
|
|
119
|
+
|
|
120
|
+
```bash
|
|
121
|
+
# Development
|
|
122
|
+
bunpress dev # Start dev server with hot reload
|
|
123
|
+
bunpress build # Build for production
|
|
124
|
+
bunpress preview # Preview production build
|
|
125
|
+
|
|
126
|
+
# Content Management
|
|
127
|
+
bunpress new <path> # Create new markdown file
|
|
128
|
+
bunpress init # Initialize new project
|
|
129
|
+
|
|
130
|
+
# Maintenance
|
|
131
|
+
bunpress clean # Remove build artifacts
|
|
132
|
+
bunpress stats # Show documentation statistics
|
|
133
|
+
bunpress doctor # Run diagnostic checks
|
|
134
|
+
|
|
135
|
+
# SEO
|
|
136
|
+
bunpress seo:check # Check SEO for all pages
|
|
137
|
+
bunpress seo:check --fix # Auto-fix SEO issues
|
|
138
|
+
|
|
139
|
+
# Configuration
|
|
140
|
+
bunpress config:show # Show current configuration
|
|
141
|
+
bunpress config:validate # Validate configuration
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
## Performance Benchmarks
|
|
145
|
+
|
|
146
|
+
BunPress is **the fastest** documentation generator available. Our benchmarks use the same methodology as [11ty's official performance tests](https://www.11ty.dev/docs/performance/) with 4,000 markdown files:
|
|
147
|
+
|
|
148
|
+
### Build Performance (4,000 markdown files)
|
|
149
|
+
|
|
150
|
+
| Generator | Build Time | vs BunPress |
|
|
151
|
+
|-----------|-----------|-------------|
|
|
152
|
+
| **BunPress** | **0.18s** | - |
|
|
153
|
+
| Eleventy | 1.93s | 11x slower |
|
|
154
|
+
| Astro | 22.90s | 130x slower |
|
|
155
|
+
| Gatsby | 29.05s | 165x slower |
|
|
156
|
+
| Next.js | 70.65s | 401x slower |
|
|
157
|
+
|
|
158
|
+
### Full-Featured Build (with syntax highlighting)
|
|
159
|
+
|
|
160
|
+
| Generator | Build Time | vs BunPress |
|
|
161
|
+
|-----------|-----------|-------------|
|
|
162
|
+
| **BunPress** | **4.12s** | - |
|
|
163
|
+
| Astro | 22.90s | 5.6x slower |
|
|
164
|
+
| Gatsby | 29.05s | 7x slower |
|
|
165
|
+
| Next.js | 70.65s | 17x slower |
|
|
166
|
+
|
|
167
|
+
**BunPress processes 22,000+ files per second** in fast mode, making it the fastest static site generator for documentation.
|
|
168
|
+
|
|
169
|
+
Run the benchmark yourself:
|
|
170
|
+
```bash
|
|
171
|
+
bun test test/benchmark.test.ts
|
|
172
|
+
```
|
|
173
|
+
|
|
90
174
|
## Testing
|
|
91
175
|
|
|
92
176
|
```bash
|
|
93
|
-
bun test
|
|
177
|
+
bun test # Run all tests
|
|
178
|
+
bun test:quick # Quick test run (10s timeout)
|
|
179
|
+
bun run typecheck # Type checking
|
|
180
|
+
bun run lint # Lint code
|
|
94
181
|
```
|
|
95
182
|
|
|
96
183
|
## Changelog
|
|
97
184
|
|
|
98
|
-
Please see our [releases](https://github.com/
|
|
185
|
+
Please see our [releases](https://github.com/stacksjs/bunpress/releases) page for more information on what has changed recently.
|
|
99
186
|
|
|
100
187
|
## Contributing
|
|
101
188
|
|
|
@@ -105,7 +192,7 @@ Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
|
|
|
105
192
|
|
|
106
193
|
For help, discussion about best practices, or any other conversation that would benefit from being searchable:
|
|
107
194
|
|
|
108
|
-
[Discussions on GitHub](https://github.com/stacksjs/
|
|
195
|
+
[Discussions on GitHub](https://github.com/stacksjs/bunpress/discussions)
|
|
109
196
|
|
|
110
197
|
For casual chit-chat with others using this package:
|
|
111
198
|
|
|
@@ -131,10 +218,10 @@ The MIT License (MIT). Please see [LICENSE](LICENSE.md) for more information.
|
|
|
131
218
|
Made with ๐
|
|
132
219
|
|
|
133
220
|
<!-- Badges -->
|
|
134
|
-
[npm-version-src]: https://img.shields.io/npm/v/
|
|
135
|
-
[npm-version-href]: https://npmjs.com/package/
|
|
136
|
-
[github-actions-src]: https://img.shields.io/github/actions/workflow/status/stacksjs/
|
|
137
|
-
[github-actions-href]: https://github.com/stacksjs/
|
|
221
|
+
[npm-version-src]: https://img.shields.io/npm/v/@stacksjs/bunpress?style=flat-square
|
|
222
|
+
[npm-version-href]: https://npmjs.com/package/@stacksjs/bunpress
|
|
223
|
+
[github-actions-src]: https://img.shields.io/github/actions/workflow/status/stacksjs/bunpress/ci.yml?style=flat-square&branch=main
|
|
224
|
+
[github-actions-href]: https://github.com/stacksjs/bunpress/actions?query=workflow%3Aci
|
|
138
225
|
|
|
139
|
-
<!-- [codecov-src]: https://img.shields.io/codecov/c/gh/stacksjs/
|
|
140
|
-
[codecov-href]: https://codecov.io/gh/stacksjs/
|
|
226
|
+
<!-- [codecov-src]: https://img.shields.io/codecov/c/gh/stacksjs/bunpress/main?style=flat-square
|
|
227
|
+
[codecov-href]: https://codecov.io/gh/stacksjs/bunpress -->
|