Skip to content

Commit

Permalink
add README.md to renderer packages
Browse files Browse the repository at this point in the history
  • Loading branch information
uenoB committed Dec 9, 2023
1 parent f8a8c56 commit 3e51dcc
Show file tree
Hide file tree
Showing 6 changed files with 65 additions and 4 deletions.
24 changes: 20 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,27 @@ framework, so that it does not hide anything in JS and Vite from the
users.
With Minissg, any decision and convention for static site generation
are up to you; for example, you can write your static webpages with
any of your favorite technologies including [React], [Preact],
[Solid], [Svelte], [Vue], [Markdown], [MDX], and even any combination
of them, in exchange of a little effort to write some JS code and some
configurations in `vite.config.js`.
any combination of your favorite JS technologies in exchange of a
little effort to write some JS code and some configurations in
`vite.config.js`.

See [packages/vite-plugin-minissg/README.md] for details.

## Packages

This is a monorepo containing Minissg and its related packages.

* [vite-plugin-minissg]
* [@minissg/render-preact]
* [@minissg/render-react]
* [@minissg/render-solid]
* [@minissg/render-svelte]
* [@minissg/render-vue]

[packages/vite-plugin-minissg/README.md]: packages/vite-plugin-minissg/README.md
[vite-plugin-minissg]: packages/vite-plugin-minissg
[@minissg/render-preact]: packages/render-preact
[@minissg/render-react]: packages/render-react
[@minissg/render-solid]: packages/render-solid
[@minissg/render-svelte]: packages/render-svelte
[@minissg/render-vue]: packages/render-vue
9 changes: 9 additions & 0 deletions packages/render-preact/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# @minissg/render-preact

A renderer plugin for combining [Minissg] with [Preact].

See [Minissg's README] for details.

[Minissg]: https://github.com/uenoB/vite-plugin-minissg
[Preact]: https://preactjs.com
[Minissg's README]: https://github.com/uenoB/vite-plugin-minissg/blob/main/packages/vite-plugin-minissg/README.md
9 changes: 9 additions & 0 deletions packages/render-react/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# @minissg/render-react

A renderer plugin for combining [Minissg] with [React].

See [Minissg's README] for details.

[Minissg]: https://github.com/uenoB/vite-plugin-minissg
[React]: https://react.dev
[Minissg's README]: https://github.com/uenoB/vite-plugin-minissg/blob/main/packages/vite-plugin-minissg/README.md
9 changes: 9 additions & 0 deletions packages/render-solid/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# @minissg/render-solid

A renderer plugin for combining [Minissg] with [Solid.js].

See [Minissg's README] for details.

[Minissg]: https://github.com/uenoB/vite-plugin-minissg
[Solid.js]: https://www.solidjs.com
[Minissg's README]: https://github.com/uenoB/vite-plugin-minissg/blob/main/packages/vite-plugin-minissg/README.md
9 changes: 9 additions & 0 deletions packages/render-svelte/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# @minissg/render-svelte

A renderer plugin for combining [Minissg] with [Svelte].

See [Minissg's README] for details.

[Minissg]: https://github.com/uenoB/vite-plugin-minissg
[Svelte]: https://svelte.dev
[Minissg's README]: https://github.com/uenoB/vite-plugin-minissg/blob/main/packages/vite-plugin-minissg/README.md
9 changes: 9 additions & 0 deletions packages/render-vue/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# @minissg/render-vue

A renderer plugin for combining [Minissg] with [Vue].

See [Minissg's README] for details.

[Minissg]: https://github.com/uenoB/vite-plugin-minissg
[Vue]: https://vuejs.org
[Minissg's README]: https://github.com/uenoB/vite-plugin-minissg/blob/main/packages/vite-plugin-minissg/README.md

0 comments on commit 3e51dcc

Please sign in to comment.