Comments (6)
Thanks for creating this issue!
Yes, definitely. I'm planning on deploying a doc site with interactive playground so that users may try the components while reading the docs. I have done this before so this could be a breeze to implement. Writing the docs, on the other hand, might be a lot of work, although no worries. This should probably come by late October as I have other plans to execute earlier.
I'll keep this issue open for a while to notify about the upcoming docs update.
Edit:
I'm currently exploring Astro's doc template.
from terracotta.
For myself, I just took your examples and put them into a (many) multistage Dockerfile to build every example in parallel.
Then I deployed it to fly.io for testing reasons https://solid-headless-demo.fly.dev/
This isn't really beautiful yet but maybe something like that would be enough. Each demo is loaded as an iframe to the single startpage.
If someone want to start it locally (it is just an alpine nginx):
docker pull matthiasbaldi/solid-headless-demo:latest
docker run --rm -p 8080:80 matthiasbaldi/solid-headless-demo:latest
I can make it a bit more beautiful if there is some interest and can also publish it on Github or create an PR for the two additional files I created (Dockerfile & index.html).
from terracotta.
Here's a demo badge
[![Open in CodeSandbox](https://img.shields.io/badge/Open%20in-CodeSandbox-blue?style=flat-square&logo=codesandbox)](https://codesandbox.io/s/github/LXSMNSYC/solid-headless/tree/main/examples/accordion-example)
from terracotta.
@lxsmnsyc How is http://solid-headless.vercel.app maintained? The Modal example there is not the same as in this repo. And the vercel pipeline doesn't seem to work currently on this repo.
I see you added a link to codesandbox https://codesandbox.io/s/github/LXSMNSYC/solid-headless/tree/main/examples/tabs-example/ for the Tabs component in your release notes https://github.com/LXSMNSYC/solid-headless/releases/tag/v0.12.0
Codesandbox is getting the example from github directly? That's nice.
We could add a codesandbox link for each component in the README. What do you think?
from terracotta.
How is http://solid-headless.vercel.app/ maintained? The Modal example there is not the same as in this repo. And the vercel pipeline doesn't seem to work currently on this repo.
The docs site is still experimental. I'm trying to design so that it looks like it has its own UI design but the thing blocking me is how each component is going to be documented (e.g. structure, things that needs to be explained, etc).
I see you added a link to codesandbox https://codesandbox.io/s/github/LXSMNSYC/solid-headless/tree/main/examples/tabs-example/ for the Tabs component in your release notes https://github.com/LXSMNSYC/solid-headless/releases/tag/v0.12.0
Codesandbox is getting the example from github directly? That's nice.
We could add a codesandbox link for each component in the README. What do you think?
Yes we could add codesandbox badges. Weird that I do this in my other repos but not here, but yeah, it's good to be added.
from terracotta.
You're talking about codesandbox badge, is this a special button? I'm not used to codesandbox. Do you have an example in another repo? I'm willing to create a PR to add the links.
from terracotta.
Related Issues (20)
- Popover but without the close on blur HOT 6
- Combobox HOT 6
- Popover transition enter doesn't work. HOT 3
- Missing `Tab.Panels` component HOT 4
- Issue when using solid-headless with Astro HOT 5
- Modal allows background text selection & scroll HOT 6
- Usage with Islands? HOT 6
- Can you add some installation instructions please? HOT 1
- `HTMLElement is not defined` when using SSR, render function & `createResource` HOT 1
- Do you have alternative for headlessUI Switch? HOT 1
- Can we have example for select please? HOT 1
- Menu components that are difficult to understand
- Hide PopoverPanel on href/link click HOT 1
- createUniqueId in Toaster causes issues with solid-start HOT 6
- listbox with multiple prop unable to unselect option HOT 1
- What do I use instead of Fragment? HOT 1
- Add docs please, trying to add checkbox, nothing gets shown HOT 2
- Can't use with solid start HOT 6
- 1.0 release
- TypeError: Cannot read properties of undefined (reading 'matches') HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from terracotta.