@rocket/js 0.0.0 → 0.1.0
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/LICENSE +21 -0
- package/README.md +224 -2
- package/dist-types/exports/MainMenu.d.ts +2 -0
- package/dist-types/exports/MainMenu.d.ts.map +1 -0
- package/dist-types/exports/PageData.d.ts +2 -0
- package/dist-types/exports/PageData.d.ts.map +1 -0
- package/dist-types/exports/RocketCodeBlock.d.ts +2 -0
- package/dist-types/exports/RocketCodeBlock.d.ts.map +1 -0
- package/dist-types/exports/RocketIcon.d.ts +2 -0
- package/dist-types/exports/RocketIcon.d.ts.map +1 -0
- package/dist-types/exports/RocketJsDemo.d.ts +2 -0
- package/dist-types/exports/RocketJsDemo.d.ts.map +1 -0
- package/dist-types/exports/RocketRequestDemo.d.ts +2 -0
- package/dist-types/exports/RocketRequestDemo.d.ts.map +1 -0
- package/dist-types/exports/SocialPreviewPlayground.d.ts +2 -0
- package/dist-types/exports/SocialPreviewPlayground.d.ts.map +1 -0
- package/dist-types/exports/adapters/netlify.d.ts +2 -0
- package/dist-types/exports/adapters/netlify.d.ts.map +1 -0
- package/dist-types/exports/asyncMessage.d.ts +2 -0
- package/dist-types/exports/asyncMessage.d.ts.map +1 -0
- package/dist-types/exports/component-hydration.d.ts +2 -0
- package/dist-types/exports/component-hydration.d.ts.map +1 -0
- package/dist-types/exports/components/web-awesome.d.ts +3 -0
- package/dist-types/exports/components/web-awesome.d.ts.map +1 -0
- package/dist-types/exports/components.d.ts +2 -0
- package/dist-types/exports/components.d.ts.map +1 -0
- package/dist-types/exports/config.d.ts +2 -0
- package/dist-types/exports/config.d.ts.map +1 -0
- package/dist-types/exports/debounce.d.ts +2 -0
- package/dist-types/exports/debounce.d.ts.map +1 -0
- package/dist-types/exports/define/RocketCodeBlock.d.ts +2 -0
- package/dist-types/exports/define/RocketCodeBlock.d.ts.map +1 -0
- package/dist-types/exports/define/RocketIcon.d.ts +2 -0
- package/dist-types/exports/define/RocketIcon.d.ts.map +1 -0
- package/dist-types/exports/define/RocketJsDemo.d.ts +2 -0
- package/dist-types/exports/define/RocketJsDemo.d.ts.map +1 -0
- package/dist-types/exports/define/RocketRequestDemo.d.ts +2 -0
- package/dist-types/exports/define/RocketRequestDemo.d.ts.map +1 -0
- package/dist-types/exports/define/menus.d.ts +2 -0
- package/dist-types/exports/define/menus.d.ts.map +1 -0
- package/dist-types/exports/extractCode.d.ts +2 -0
- package/dist-types/exports/extractCode.d.ts.map +1 -0
- package/dist-types/exports/globalData.d.ts +2 -0
- package/dist-types/exports/globalData.d.ts.map +1 -0
- package/dist-types/exports/hydration/hydrationLoader.d.ts +2 -0
- package/dist-types/exports/hydration/hydrationLoader.d.ts.map +1 -0
- package/dist-types/exports/icons.d.ts +2 -0
- package/dist-types/exports/icons.d.ts.map +1 -0
- package/dist-types/exports/layout-helper.d.ts +2 -0
- package/dist-types/exports/layout-helper.d.ts.map +1 -0
- package/dist-types/exports/layout.d.ts +2 -0
- package/dist-types/exports/layout.d.ts.map +1 -0
- package/dist-types/exports/layouts/atlasDoc.d.ts +2 -0
- package/dist-types/exports/layouts/atlasDoc.d.ts.map +1 -0
- package/dist-types/exports/layouts/atlasHero.d.ts +2 -0
- package/dist-types/exports/layouts/atlasHero.d.ts.map +1 -0
- package/dist-types/exports/layouts/atlasNotFound.d.ts +2 -0
- package/dist-types/exports/layouts/atlasNotFound.d.ts.map +1 -0
- package/dist-types/exports/loaded-page-module.d.ts +2 -0
- package/dist-types/exports/loaded-page-module.d.ts.map +1 -0
- package/dist-types/exports/markdownHook.d.ts +2 -0
- package/dist-types/exports/markdownHook.d.ts.map +1 -0
- package/dist-types/exports/menu.d.ts +2 -0
- package/dist-types/exports/menu.d.ts.map +1 -0
- package/dist-types/exports/menus.d.ts +6 -0
- package/dist-types/exports/menus.d.ts.map +1 -0
- package/dist-types/exports/page-runtime.d.ts +2 -0
- package/dist-types/exports/page-runtime.d.ts.map +1 -0
- package/dist-types/exports/pages.d.ts +2 -0
- package/dist-types/exports/pages.d.ts.map +1 -0
- package/dist-types/exports/resolve.d.ts +2 -0
- package/dist-types/exports/resolve.d.ts.map +1 -0
- package/dist-types/exports/ssr.d.ts +2 -0
- package/dist-types/exports/ssr.d.ts.map +1 -0
- package/dist-types/exports/standalone-demo-url.d.ts +2 -0
- package/dist-types/exports/standalone-demo-url.d.ts.map +1 -0
- package/dist-types/exports/transform.d.ts +2 -0
- package/dist-types/exports/transform.d.ts.map +1 -0
- package/dist-types/exports/types/hydration.d.ts +23 -0
- package/dist-types/exports/types/hydration.d.ts.map +1 -0
- package/dist-types/exports/types/rocket.d.ts +504 -0
- package/dist-types/exports/types/rocket.d.ts.map +1 -0
- package/dist-types/exports/types.d.ts +3 -0
- package/dist-types/exports/types.d.ts.map +1 -0
- package/dist-types/exports/wds-plugin.d.ts +2 -0
- package/dist-types/exports/wds-plugin.d.ts.map +1 -0
- package/dist-types/src/PageData.d.ts +82 -0
- package/dist-types/src/PageData.d.ts.map +1 -0
- package/dist-types/src/RocketCodeBlock.d.ts +64 -0
- package/dist-types/src/RocketCodeBlock.d.ts.map +1 -0
- package/dist-types/src/RocketIcon.d.ts +35 -0
- package/dist-types/src/RocketIcon.d.ts.map +1 -0
- package/dist-types/src/RocketJsDemo.d.ts +59 -0
- package/dist-types/src/RocketJsDemo.d.ts.map +1 -0
- package/dist-types/src/RocketJsDemo.test-browser.d.ts +3 -0
- package/dist-types/src/RocketJsDemo.test-browser.d.ts.map +1 -0
- package/dist-types/src/RocketRequestDemo.d.ts +57 -0
- package/dist-types/src/RocketRequestDemo.d.ts.map +1 -0
- package/dist-types/src/RocketRequestDemo.test-browser.d.ts +3 -0
- package/dist-types/src/RocketRequestDemo.test-browser.d.ts.map +1 -0
- package/dist-types/src/SocialPreviewPlayground.d.ts +102 -0
- package/dist-types/src/SocialPreviewPlayground.d.ts.map +1 -0
- package/dist-types/src/adapters/netlify.d.ts +54 -0
- package/dist-types/src/adapters/netlify.d.ts.map +1 -0
- package/dist-types/src/asyncMessage.d.ts +14 -0
- package/dist-types/src/asyncMessage.d.ts.map +1 -0
- package/dist-types/src/cli/RocketBuild.d.ts +78 -0
- package/dist-types/src/cli/RocketBuild.d.ts.map +1 -0
- package/dist-types/src/cli/RocketCli.d.ts +17 -0
- package/dist-types/src/cli/RocketCli.d.ts.map +1 -0
- package/dist-types/src/cli/RocketInit.d.ts +22 -0
- package/dist-types/src/cli/RocketInit.d.ts.map +1 -0
- package/dist-types/src/cli/RocketStart.d.ts +13 -0
- package/dist-types/src/cli/RocketStart.d.ts.map +1 -0
- package/dist-types/src/cli/cli.d.ts +3 -0
- package/dist-types/src/cli/cli.d.ts.map +1 -0
- package/dist-types/src/component-hydration.d.ts +26 -0
- package/dist-types/src/component-hydration.d.ts.map +1 -0
- package/dist-types/src/components/FeatureList.d.ts +15 -0
- package/dist-types/src/components/FeatureList.d.ts.map +1 -0
- package/dist-types/src/components/Footer.d.ts +17 -0
- package/dist-types/src/components/Footer.d.ts.map +1 -0
- package/dist-types/src/components/Header.d.ts +6 -0
- package/dist-types/src/components/Header.d.ts.map +1 -0
- package/dist-types/src/components/RocketDrawer.d.ts +20 -0
- package/dist-types/src/components/RocketDrawer.d.ts.map +1 -0
- package/dist-types/src/components/RocketSocialLink.d.ts +30 -0
- package/dist-types/src/components/RocketSocialLink.d.ts.map +1 -0
- package/dist-types/src/components.d.ts +5 -0
- package/dist-types/src/components.d.ts.map +1 -0
- package/dist-types/src/config.d.ts +6 -0
- package/dist-types/src/config.d.ts.map +1 -0
- package/dist-types/src/debounce.d.ts +8 -0
- package/dist-types/src/debounce.d.ts.map +1 -0
- package/dist-types/src/defaultSocialPreviewTemplate.d.ts +31 -0
- package/dist-types/src/defaultSocialPreviewTemplate.d.ts.map +1 -0
- package/dist-types/src/development-page-module-loader.d.ts +15 -0
- package/dist-types/src/development-page-module-loader.d.ts.map +1 -0
- package/dist-types/src/extractCode.d.ts +5 -0
- package/dist-types/src/extractCode.d.ts.map +1 -0
- package/dist-types/src/hydration/evaluate.d.ts +20 -0
- package/dist-types/src/hydration/evaluate.d.ts.map +1 -0
- package/dist-types/src/hydration/extractStrategies.d.ts +5 -0
- package/dist-types/src/hydration/extractStrategies.d.ts.map +1 -0
- package/dist-types/src/hydration/hydrationLoader.d.ts +64 -0
- package/dist-types/src/hydration/hydrationLoader.d.ts.map +1 -0
- package/dist-types/src/icons.d.ts +170 -0
- package/dist-types/src/icons.d.ts.map +1 -0
- package/dist-types/src/layouts/atlas/atlasDocLayout.d.ts +45 -0
- package/dist-types/src/layouts/atlas/atlasDocLayout.d.ts.map +1 -0
- package/dist-types/src/layouts/atlas/atlasHeroLayout.d.ts +7 -0
- package/dist-types/src/layouts/atlas/atlasHeroLayout.d.ts.map +1 -0
- package/dist-types/src/layouts/atlas/atlasNotFoundLayout.d.ts +5 -0
- package/dist-types/src/layouts/atlas/atlasNotFoundLayout.d.ts.map +1 -0
- package/dist-types/src/layouts/layout-helper.d.ts +16 -0
- package/dist-types/src/layouts/layout-helper.d.ts.map +1 -0
- package/dist-types/src/layouts/layout.d.ts +9 -0
- package/dist-types/src/layouts/layout.d.ts.map +1 -0
- package/dist-types/src/loaded-page-module.d.ts +51 -0
- package/dist-types/src/loaded-page-module.d.ts.map +1 -0
- package/dist-types/src/main.d.ts +2 -0
- package/dist-types/src/main.d.ts.map +1 -0
- package/dist-types/src/markdownCompiler.d.ts +22 -0
- package/dist-types/src/markdownCompiler.d.ts.map +1 -0
- package/dist-types/src/markdownHook.d.ts +6 -0
- package/dist-types/src/markdownHook.d.ts.map +1 -0
- package/dist-types/src/menu.d.ts +22 -0
- package/dist-types/src/menu.d.ts.map +1 -0
- package/dist-types/src/menus/MainMenu.d.ts +23 -0
- package/dist-types/src/menus/MainMenu.d.ts.map +1 -0
- package/dist-types/src/menus/RocketMenu.d.ts +23 -0
- package/dist-types/src/menus/RocketMenu.d.ts.map +1 -0
- package/dist-types/src/menus/RocketNextPage.d.ts +18 -0
- package/dist-types/src/menus/RocketNextPage.d.ts.map +1 -0
- package/dist-types/src/menus/RocketPreviousPage.d.ts +18 -0
- package/dist-types/src/menus/RocketPreviousPage.d.ts.map +1 -0
- package/dist-types/src/menus/RocketToc.d.ts +54 -0
- package/dist-types/src/menus/RocketToc.d.ts.map +1 -0
- package/dist-types/src/menus/pageNavigation.d.ts +41 -0
- package/dist-types/src/menus/pageNavigation.d.ts.map +1 -0
- package/dist-types/src/page-pagination.d.ts +69 -0
- package/dist-types/src/page-pagination.d.ts.map +1 -0
- package/dist-types/src/page-runtime.d.ts +110 -0
- package/dist-types/src/page-runtime.d.ts.map +1 -0
- package/dist-types/src/pages.d.ts +10 -0
- package/dist-types/src/pages.d.ts.map +1 -0
- package/dist-types/src/publicAssets.d.ts +70 -0
- package/dist-types/src/publicAssets.d.ts.map +1 -0
- package/dist-types/src/requestDemoMetadata.d.ts +19 -0
- package/dist-types/src/requestDemoMetadata.d.ts.map +1 -0
- package/dist-types/src/resolve.d.ts +7 -0
- package/dist-types/src/resolve.d.ts.map +1 -0
- package/dist-types/src/siteDiscoverability.d.ts +33 -0
- package/dist-types/src/siteDiscoverability.d.ts.map +1 -0
- package/dist-types/src/siteHeadMetadata.d.ts +20 -0
- package/dist-types/src/siteHeadMetadata.d.ts.map +1 -0
- package/dist-types/src/socialPreviewImages.d.ts +186 -0
- package/dist-types/src/socialPreviewImages.d.ts.map +1 -0
- package/dist-types/src/socialPreviewTemplatePreview.d.ts +22 -0
- package/dist-types/src/socialPreviewTemplatePreview.d.ts.map +1 -0
- package/dist-types/src/ssr.d.ts +6 -0
- package/dist-types/src/ssr.d.ts.map +1 -0
- package/dist-types/src/standalone-demo-url.d.ts +60 -0
- package/dist-types/src/standalone-demo-url.d.ts.map +1 -0
- package/dist-types/src/static-page-module-loader.d.ts +15 -0
- package/dist-types/src/static-page-module-loader.d.ts.map +1 -0
- package/dist-types/src/transform.d.ts +10 -0
- package/dist-types/src/transform.d.ts.map +1 -0
- package/dist-types/src/urlLifecycle.d.ts +23 -0
- package/dist-types/src/urlLifecycle.d.ts.map +1 -0
- package/dist-types/src/wds-plugin.d.ts +14 -0
- package/dist-types/src/wds-plugin.d.ts.map +1 -0
- package/docs/assets/home-background.svg +1 -0
- package/docs/assets/prism-one-light.css +368 -0
- package/docs/assets/rocket-logo-dark-with-text-below.svg +8 -0
- package/docs/assets/rocket-logo-dark-with-text.svg +7 -0
- package/docs/assets/rocket-logo-dark.svg +7 -0
- package/docs/assets/rocket-logo-light-with-text-below.svg +14 -0
- package/docs/assets/rocket-logo-light-with-text.svg +13 -0
- package/docs/assets/rocket-logo-light.svg +12 -0
- package/docs/assets/rocket-text-no-logo.svg +3 -0
- package/exports/MainMenu.js +1 -0
- package/exports/PageData.js +1 -0
- package/exports/RocketCodeBlock.js +1 -0
- package/exports/RocketIcon.js +1 -0
- package/exports/RocketJsDemo.js +1 -0
- package/exports/RocketRequestDemo.js +1 -0
- package/exports/SocialPreviewPlayground.js +1 -0
- package/exports/adapters/netlify.js +1 -0
- package/exports/asyncMessage.js +1 -0
- package/exports/component-hydration.js +1 -0
- package/exports/components/web-awesome.js +63 -0
- package/exports/components.js +1 -0
- package/exports/config.js +1 -0
- package/exports/debounce.js +1 -0
- package/exports/define/RocketCodeBlock.js +2 -0
- package/exports/define/RocketIcon.js +3 -0
- package/exports/define/RocketJsDemo.js +5 -0
- package/exports/define/RocketRequestDemo.js +5 -0
- package/exports/define/menus.js +14 -0
- package/exports/extractCode.js +1 -0
- package/exports/globalData.js +1 -0
- package/exports/hydration/hydrationLoader.js +1 -0
- package/exports/icons.js +8 -0
- package/exports/layout-helper.js +1 -0
- package/exports/layout.js +1 -0
- package/exports/layouts/_atlas.css +3 -0
- package/exports/layouts/atlasDoc.js +5 -0
- package/exports/layouts/atlasHero.js +1 -0
- package/exports/layouts/atlasNotFound.js +4 -0
- package/exports/loaded-page-module.js +5 -0
- package/exports/markdownHook.js +4 -0
- package/exports/menu.js +4 -0
- package/exports/menus.js +5 -0
- package/exports/page-runtime.js +5 -0
- package/exports/pages.js +1 -0
- package/exports/resolve.js +1 -0
- package/exports/ssr.js +1 -0
- package/exports/standalone-demo-url.js +10 -0
- package/exports/transform.js +1 -0
- package/exports/types/hydration.ts +26 -0
- package/exports/types/rocket.ts +598 -0
- package/exports/types.ts +71 -0
- package/exports/wds-plugin.js +1 -0
- package/package.json +192 -9
- package/src/PageData.js +244 -0
- package/src/RocketCodeBlock.js +516 -0
- package/src/RocketIcon.js +291 -0
- package/src/RocketJsDemo.js +397 -0
- package/src/RocketJsDemo.test-browser.js +228 -0
- package/src/RocketRequestDemo.js +439 -0
- package/src/RocketRequestDemo.test-browser.js +301 -0
- package/src/SocialPreviewPlayground.js +573 -0
- package/src/adapters/netlify.js +814 -0
- package/src/asyncMessage.js +21 -0
- package/src/cli/RocketBuild.js +545 -0
- package/src/cli/RocketCli.js +47 -0
- package/src/cli/RocketInit.js +323 -0
- package/src/cli/RocketStart.js +79 -0
- package/src/cli/cli.js +7 -0
- package/src/component-hydration.js +86 -0
- package/src/components/FeatureList.js +114 -0
- package/src/components/Footer.js +116 -0
- package/src/components/Header.js +122 -0
- package/src/components/RocketDrawer.js +193 -0
- package/src/components/RocketSocialLink.js +128 -0
- package/src/components/assets/discord.svg +7 -0
- package/src/components/assets/github.svg +4 -0
- package/src/components/assets/gitlab.svg +1 -0
- package/src/components/assets/info.txt +1 -0
- package/src/components/assets/license.svg +3 -0
- package/src/components/assets/npm.svg +5 -0
- package/src/components/assets/slack.svg +5 -0
- package/src/components/assets/telegram.svg +4 -0
- package/src/components/assets/twitter.svg +1 -0
- package/src/components.js +15 -0
- package/src/config.js +319 -0
- package/src/debounce.js +21 -0
- package/src/defaultSocialPreviewTemplate.js +118 -0
- package/src/development-page-module-loader.js +29 -0
- package/src/extractCode.js +41 -0
- package/src/hydration/evaluate.js +54 -0
- package/src/hydration/extractStrategies.js +91 -0
- package/src/hydration/hydrationLoader.js +330 -0
- package/src/icons.js +883 -0
- package/src/layouts/atlas/atlasDoc.css +877 -0
- package/src/layouts/atlas/atlasDocLayout.js +288 -0
- package/src/layouts/atlas/atlasHero.css +774 -0
- package/src/layouts/atlas/atlasHeroLayout.js +346 -0
- package/src/layouts/atlas/atlasNotFound.css +365 -0
- package/src/layouts/atlas/atlasNotFoundLayout.js +69 -0
- package/src/layouts/layout-helper.js +92 -0
- package/src/layouts/layout.js +62 -0
- package/src/loaded-page-module.js +97 -0
- package/src/main.js +55 -0
- package/src/markdownCompiler.js +303 -0
- package/src/markdownHook.js +148 -0
- package/src/menu.js +210 -0
- package/src/menus/MainMenu.js +58 -0
- package/src/menus/RocketMenu.js +191 -0
- package/src/menus/RocketNextPage.js +25 -0
- package/src/menus/RocketPreviousPage.js +29 -0
- package/src/menus/RocketToc.js +309 -0
- package/src/menus/pageNavigation.js +285 -0
- package/src/page-pagination.js +241 -0
- package/src/page-runtime.js +481 -0
- package/src/pages.js +537 -0
- package/src/publicAssets.js +336 -0
- package/src/requestDemoMetadata.js +97 -0
- package/src/resolve.js +15 -0
- package/src/siteDiscoverability.js +184 -0
- package/src/siteHeadMetadata.js +69 -0
- package/src/socialPreviewImages.js +482 -0
- package/src/socialPreviewTemplatePreview.js +352 -0
- package/src/ssr.js +14 -0
- package/src/standalone-demo-url.js +134 -0
- package/src/static-page-module-loader.js +29 -0
- package/src/transform.js +633 -0
- package/src/urlLifecycle.js +57 -0
- package/src/wds-plugin.js +302 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 modern-web.dev
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,3 +1,225 @@
|
|
|
1
|
-
|
|
1
|
+
> Rocket is in alpha. Expect APIs and documentation to keep improving before 1.0.
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
<p align="center">
|
|
4
|
+
<picture width="60%">
|
|
5
|
+
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/modernweb-dev/rocket/main/docs/assets/rocket-logo-dark-with-text.svg">
|
|
6
|
+
<img alt="Rocket Logo" src="https://raw.githubusercontent.com/modernweb-dev/rocket/main/docs/assets/rocket-logo-light-with-text.svg">
|
|
7
|
+
</picture>
|
|
8
|
+
</p>
|
|
9
|
+
|
|
10
|
+
<p align="center">
|
|
11
|
+
<a href="https://github.com/modernweb-dev/rocket/actions"
|
|
12
|
+
><img
|
|
13
|
+
src="https://img.shields.io/github/actions/workflow/status/modernweb-dev/rocket/release.yml?branch=main&label=release&style=flat-square"
|
|
14
|
+
alt="Release workflow status"
|
|
15
|
+
/></a>
|
|
16
|
+
<a href="https://twitter.com/modern_web_dev"
|
|
17
|
+
><img
|
|
18
|
+
src="https://img.shields.io/badge/twitter-@modern_web_dev-1DA1F3?style=flat-square"
|
|
19
|
+
alt="Follow @modern_web_dev on Twitter"
|
|
20
|
+
/></a>
|
|
21
|
+
<a href="https://open.vscode.dev/modernweb-dev/rocket"
|
|
22
|
+
><img
|
|
23
|
+
src="https://img.shields.io/static/v1?logo=visualstudiocode&label=&message=Open%20in%20Visual%20Studio%20Code&labelColor=2c2c32&color=007acc&logoColor=007acc"
|
|
24
|
+
alt="Open in VS Code"
|
|
25
|
+
/></a>
|
|
26
|
+
</p>
|
|
27
|
+
|
|
28
|
+
<p align="center">
|
|
29
|
+
<a href="https://rocket.modern-web.dev">Website</a>
|
|
30
|
+
·
|
|
31
|
+
<a href="https://rocket.modern-web.dev/setup/build-with-ai">Start with AI</a>
|
|
32
|
+
·
|
|
33
|
+
<a href="https://rocket.modern-web.dev/chat">Discord Community</a>
|
|
34
|
+
</p>
|
|
35
|
+
|
|
36
|
+
# Rocket
|
|
37
|
+
|
|
38
|
+
Rocket is a static-site metaframework for content sites and Web Component docs: HTML-first, zero JS
|
|
39
|
+
by default, AI-friendly, and deployable anywhere.
|
|
40
|
+
|
|
41
|
+
- **Start with AI:** Copy the starter prompt, paste it into Claude, Cursor, Codex, or another
|
|
42
|
+
coding agent, and get a deployable Rocket site made of plain files.
|
|
43
|
+
- **Content first:** Write durable pages in Markdown, then opt into JavaScript only when it helps.
|
|
44
|
+
- **Explicit routes:** Each Page owns its public URL with `config.path`, independent of file
|
|
45
|
+
location.
|
|
46
|
+
- **Component loading:** Choose `server`, `client`, or `hydrate:*` per Registered Component.
|
|
47
|
+
- **Modern Web stack:** Build on Lit, Vite, and Modern Web tooling without hiding the underlying
|
|
48
|
+
configuration.
|
|
49
|
+
|
|
50
|
+
Rocket is not a SPA framework, React/Vite/Astro replacement, or backend application framework. Use
|
|
51
|
+
it when the output should mostly be static HTML and the source should stay easy for humans and
|
|
52
|
+
coding agents to inspect.
|
|
53
|
+
|
|
54
|
+
<p align="center">
|
|
55
|
+
<a href="https://rocket.modern-web.dev/setup/build-with-ai/"><strong>Start With AI ▶</strong></a>
|
|
56
|
+
·
|
|
57
|
+
<a href="https://rocket.modern-web.dev/setup/manual-quick-start/">Manual Quick Start</a>
|
|
58
|
+
</p>
|
|
59
|
+
|
|
60
|
+
## Five-minute path
|
|
61
|
+
|
|
62
|
+
Use [Start With AI](https://rocket.modern-web.dev/setup/build-with-ai/) when you want an agent to
|
|
63
|
+
create the project shell, pages, layout, metadata, and Netlify config for you:
|
|
64
|
+
|
|
65
|
+
1. Copy the Rocket prompt.
|
|
66
|
+
2. Paste it into Claude, Cursor, Codex, or another coding agent with a short Site Brief.
|
|
67
|
+
3. Let the agent create the files, run `npm run build`, and fix failures.
|
|
68
|
+
4. Keep the plain Markdown, JavaScript, CSS, and config files afterward.
|
|
69
|
+
|
|
70
|
+
Rocket requires Node.js 22 or newer.
|
|
71
|
+
|
|
72
|
+
For a manual project, install the package from npm:
|
|
73
|
+
|
|
74
|
+
```bash
|
|
75
|
+
npm install @rocket/js
|
|
76
|
+
npx rocket init
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
`rocket init` creates `rocket-config.js`, `docs/pages/index.rocket.md`, and a removable
|
|
80
|
+
project-local Rocket Agent Skill. It also adds npm scripts when the names are available:
|
|
81
|
+
|
|
82
|
+
```json
|
|
83
|
+
{
|
|
84
|
+
"type": "module",
|
|
85
|
+
"scripts": {
|
|
86
|
+
"start": "rocket start",
|
|
87
|
+
"build": "rocket build"
|
|
88
|
+
},
|
|
89
|
+
"dependencies": {
|
|
90
|
+
"@rocket/js": "^0.1.0"
|
|
91
|
+
}
|
|
92
|
+
}
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
The generated `rocket-config.js` discovers general documentation Pages under `docs/pages` and
|
|
96
|
+
colocated component reference Pages under `src`:
|
|
97
|
+
|
|
98
|
+
```js
|
|
99
|
+
/** @type {import('@rocket/js/types.js').RocketConfig} */
|
|
100
|
+
export default {
|
|
101
|
+
includeGlobs: ['docs/pages/**/*.rocket.{md,js}', 'src/**/*.rocket.{md,js}'],
|
|
102
|
+
};
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
The generated `docs/pages/index.rocket.md` gives you a first Page:
|
|
106
|
+
|
|
107
|
+
````md
|
|
108
|
+
```js server
|
|
109
|
+
export const config = {
|
|
110
|
+
path: '/',
|
|
111
|
+
metadata: {
|
|
112
|
+
title: 'Rocket Site',
|
|
113
|
+
description: 'Documentation built with Rocket.',
|
|
114
|
+
},
|
|
115
|
+
};
|
|
116
|
+
|
|
117
|
+
export { layout } from '@rocket/js/layout.js';
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
# Rocket Site
|
|
121
|
+
|
|
122
|
+
This Page is rendered by Rocket.
|
|
123
|
+
````
|
|
124
|
+
|
|
125
|
+
Then run:
|
|
126
|
+
|
|
127
|
+
```bash
|
|
128
|
+
npm start
|
|
129
|
+
npm run build
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
The build writes static output to `dist/`:
|
|
133
|
+
|
|
134
|
+
```txt
|
|
135
|
+
dist/
|
|
136
|
+
|-- index.html
|
|
137
|
+
`-- assets/
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
Follow the [Manual Quick Start](https://rocket.modern-web.dev/setup/manual-quick-start/) when you
|
|
141
|
+
want to create the smallest working project by hand.
|
|
142
|
+
|
|
143
|
+
## When to use Rocket
|
|
144
|
+
|
|
145
|
+
Use Rocket for:
|
|
146
|
+
|
|
147
|
+
- content-first static sites
|
|
148
|
+
- documentation sites
|
|
149
|
+
- Web Component and design-system docs
|
|
150
|
+
- AI-generated sites you want to own afterward
|
|
151
|
+
- pages that should ship as HTML before they ship JavaScript
|
|
152
|
+
|
|
153
|
+
Do not use Rocket for:
|
|
154
|
+
|
|
155
|
+
- SPA products with complex client-side routing
|
|
156
|
+
- backend applications
|
|
157
|
+
- projects that need a huge plugin marketplace today
|
|
158
|
+
- teams that want React, Astro, Eleventy, or VitePress conventions specifically
|
|
159
|
+
|
|
160
|
+
## Why not Astro, Eleventy, or VitePress?
|
|
161
|
+
|
|
162
|
+
Those are good tools. Rocket chooses a narrower shape:
|
|
163
|
+
|
|
164
|
+
| Need | Rocket |
|
|
165
|
+
| -------------------------- | ------ |
|
|
166
|
+
| Content-first static sites | Yes |
|
|
167
|
+
| Web Component docs | Strong |
|
|
168
|
+
| Zero JS default | Core |
|
|
169
|
+
| Explicit page config | Core |
|
|
170
|
+
| AI-friendly project shape | Core |
|
|
171
|
+
| Full app framework | No |
|
|
172
|
+
| Huge plugin ecosystem | No |
|
|
173
|
+
| React-first authoring | No |
|
|
174
|
+
|
|
175
|
+
## Package and dependency philosophy
|
|
176
|
+
|
|
177
|
+
Rocket optimizes the generated site output, not the npm dependency count. A Rocket project installs
|
|
178
|
+
`@rocket/js` and gets the build pipeline, Markdown processing, dev server, Lit-based server
|
|
179
|
+
rendering, and docs-layout affordances in one package. Visitor pages stay static by default, and
|
|
180
|
+
browser JavaScript is only emitted for loading strategies you choose.
|
|
181
|
+
|
|
182
|
+
## Status and docs
|
|
183
|
+
|
|
184
|
+
Rocket is currently **alpha** at `0.1.x`. APIs can change before `1.0.0`; breaking changes are
|
|
185
|
+
documented through changesets and release notes.
|
|
186
|
+
|
|
187
|
+
- [Start With AI](https://rocket.modern-web.dev/setup/build-with-ai/)
|
|
188
|
+
- [Manual Quick Start](https://rocket.modern-web.dev/setup/manual-quick-start/)
|
|
189
|
+
- [Build a Site](https://rocket.modern-web.dev/tutorials/acme-ui-docs)
|
|
190
|
+
- [Examples](https://rocket.modern-web.dev/examples)
|
|
191
|
+
- [Reference](https://rocket.modern-web.dev/reference)
|
|
192
|
+
- [Known Limitations](https://rocket.modern-web.dev/help/known-limitations)
|
|
193
|
+
- [Roadmap](./ROADMAP.md)
|
|
194
|
+
|
|
195
|
+
Rocket is part of the [Modern Web Family](https://modern-web.dev/discover/about/).
|
|
196
|
+
|
|
197
|
+
<p align="center">
|
|
198
|
+
<a href="https://rocket.modern-web.dev/chat"><strong>Join our Discord Community ▶</strong></a>
|
|
199
|
+
</p>
|
|
200
|
+
|
|
201
|
+
## Working on this repo
|
|
202
|
+
|
|
203
|
+
```bash
|
|
204
|
+
npm ci
|
|
205
|
+
npm start
|
|
206
|
+
npm run types
|
|
207
|
+
npm test
|
|
208
|
+
npm run lint
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
`npm start` runs the Rocket docs site. `npm test` runs the Node test suite.
|
|
212
|
+
|
|
213
|
+
## 🤝 Contributing
|
|
214
|
+
|
|
215
|
+
We are always looking for contributors of all skill levels! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/modernweb-dev/rocket/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
|
|
216
|
+
|
|
217
|
+
If you are interested in helping contribute to Modern Web, please take a look at our [Contributing Guide](https://github.com/modernweb-dev/rocket/blob/main/CONTRIBUTING.md). Also, feel free to drop into [Discord](https://rocket.modern-web.dev/chat) and say hi. 👋
|
|
218
|
+
|
|
219
|
+
### Financial Contributors
|
|
220
|
+
|
|
221
|
+
Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/modern-web/contribute)]
|
|
222
|
+
|
|
223
|
+
## License
|
|
224
|
+
|
|
225
|
+
Rocket is released under the [MIT License](./LICENSE).
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"MainMenu.d.ts","sourceRoot":"","sources":["../../exports/MainMenu.js"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"PageData.d.ts","sourceRoot":"","sources":["../../exports/PageData.js"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"RocketCodeBlock.d.ts","sourceRoot":"","sources":["../../exports/RocketCodeBlock.js"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"RocketIcon.d.ts","sourceRoot":"","sources":["../../exports/RocketIcon.js"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"RocketJsDemo.d.ts","sourceRoot":"","sources":["../../exports/RocketJsDemo.js"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"RocketRequestDemo.d.ts","sourceRoot":"","sources":["../../exports/RocketRequestDemo.js"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"SocialPreviewPlayground.d.ts","sourceRoot":"","sources":["../../exports/SocialPreviewPlayground.js"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"netlify.d.ts","sourceRoot":"","sources":["../../../exports/adapters/netlify.js"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"asyncMessage.d.ts","sourceRoot":"","sources":["../../exports/asyncMessage.js"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"component-hydration.d.ts","sourceRoot":"","sources":["../../exports/component-hydration.js"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"web-awesome.d.ts","sourceRoot":"","sources":["../../../exports/components/web-awesome.js"],"names":[],"mappings":"AAAA,uDAAuD;AACvD,mCADW,OAAO,qBAAqB,EAAE,UAAU,CA8DjD"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"components.d.ts","sourceRoot":"","sources":["../../exports/components.js"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../exports/config.js"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"debounce.d.ts","sourceRoot":"","sources":["../../exports/debounce.js"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"RocketCodeBlock.d.ts","sourceRoot":"","sources":["../../../exports/define/RocketCodeBlock.js"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"RocketIcon.d.ts","sourceRoot":"","sources":["../../../exports/define/RocketIcon.js"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"RocketJsDemo.d.ts","sourceRoot":"","sources":["../../../exports/define/RocketJsDemo.js"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"RocketRequestDemo.d.ts","sourceRoot":"","sources":["../../../exports/define/RocketRequestDemo.js"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"menus.d.ts","sourceRoot":"","sources":["../../../exports/define/menus.js"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"extractCode.d.ts","sourceRoot":"","sources":["../../exports/extractCode.js"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"globalData.d.ts","sourceRoot":"","sources":["../../exports/globalData.js"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"hydrationLoader.d.ts","sourceRoot":"","sources":["../../../exports/hydration/hydrationLoader.js"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"icons.d.ts","sourceRoot":"","sources":["../../exports/icons.js"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"layout-helper.d.ts","sourceRoot":"","sources":["../../exports/layout-helper.js"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"layout.d.ts","sourceRoot":"","sources":["../../exports/layout.js"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"atlasDoc.d.ts","sourceRoot":"","sources":["../../../exports/layouts/atlasDoc.js"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"atlasHero.d.ts","sourceRoot":"","sources":["../../../exports/layouts/atlasHero.js"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"atlasNotFound.d.ts","sourceRoot":"","sources":["../../../exports/layouts/atlasNotFound.js"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"loaded-page-module.d.ts","sourceRoot":"","sources":["../../exports/loaded-page-module.js"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"markdownHook.d.ts","sourceRoot":"","sources":["../../exports/markdownHook.js"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"menu.d.ts","sourceRoot":"","sources":["../../exports/menu.js"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
export { MainMenu } from "../src/menus/MainMenu.js";
|
|
2
|
+
export { RocketMenu } from "../src/menus/RocketMenu.js";
|
|
3
|
+
export { RocketNextPage } from "../src/menus/RocketNextPage.js";
|
|
4
|
+
export { RocketPreviousPage } from "../src/menus/RocketPreviousPage.js";
|
|
5
|
+
export { RocketToc } from "../src/menus/RocketToc.js";
|
|
6
|
+
//# sourceMappingURL=menus.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"menus.d.ts","sourceRoot":"","sources":["../../exports/menus.js"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"page-runtime.d.ts","sourceRoot":"","sources":["../../exports/page-runtime.js"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"pages.d.ts","sourceRoot":"","sources":["../../exports/pages.js"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"resolve.d.ts","sourceRoot":"","sources":["../../exports/resolve.js"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ssr.d.ts","sourceRoot":"","sources":["../../exports/ssr.js"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
export { matchStandaloneDemoUrl, normalizeDocumentPath, parseStandaloneDemoUrl, standaloneDemoPath, standaloneDemoPaths, standaloneDemoRoutePattern, standaloneDemoRoutePatterns, standaloneDemoUrl } from "../src/standalone-demo-url.js";
|
|
2
|
+
//# sourceMappingURL=standalone-demo-url.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"standalone-demo-url.d.ts","sourceRoot":"","sources":["../../exports/standalone-demo-url.js"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"transform.d.ts","sourceRoot":"","sources":["../../exports/transform.js"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
export interface ComponentImports {
|
|
2
|
+
[key: string]: () => Promise<any>;
|
|
3
|
+
}
|
|
4
|
+
export interface Strategy {
|
|
5
|
+
type: string;
|
|
6
|
+
resolveAble: boolean;
|
|
7
|
+
options?: string;
|
|
8
|
+
}
|
|
9
|
+
export interface LoadingStrategy {
|
|
10
|
+
strategyAttribute: string;
|
|
11
|
+
strategies: Strategy[];
|
|
12
|
+
strategyTemplate: string;
|
|
13
|
+
}
|
|
14
|
+
interface PotentialLitElement extends Element {
|
|
15
|
+
updateComplete?: Promise<void>;
|
|
16
|
+
}
|
|
17
|
+
export interface ElementWithStrategy extends LoadingStrategy {
|
|
18
|
+
tagName: string;
|
|
19
|
+
node: PotentialLitElement;
|
|
20
|
+
deleteMe?: boolean;
|
|
21
|
+
}
|
|
22
|
+
export {};
|
|
23
|
+
//# sourceMappingURL=hydration.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"hydration.d.ts","sourceRoot":"","sources":["../../../exports/types/hydration.ts"],"names":[],"mappings":"AACA,MAAM,WAAW,gBAAgB;IAC/B,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC;CACnC;AAED,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,OAAO,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,eAAe;IAC9B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,UAAU,EAAE,QAAQ,EAAE,CAAC;IACvB,gBAAgB,EAAE,MAAM,CAAC;CAC1B;AAED,UAAU,mBAAoB,SAAQ,OAAO;IAC3C,cAAc,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;CAChC;AAED,MAAM,WAAW,mBAAoB,SAAQ,eAAe;IAC1D,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,mBAAmB,CAAC;IAC1B,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB"}
|