This repo is a proof-of-concept for porting Idyll to Svelte.
Current Idyll compiles to Markdown + custom syntax to React components and a custom runtime. It also hacks in reactive variables. Unfortunately, the hacking does not play well with React components, Idyll files are not composable, and the compiler is very brittle and doesn't give good error messages.
This port converts Idyll to an EDSL in Svelte + MDsveX. Idyll-Svelte components are composable. Svelte handles the reactive runtime and MDsveX handles the Markdown syntax. Idyll-Svelte is effectively a component library with nice CSS templates. But don't be fooled by its simplicity! This is still a wildly useful product for people (like me) who want to craft explorable explanations and other types of interactive articles. In fact, it should be much more pleasant to use in Svelte, since Svelte components should "just work" with Idyll-Svelte.
Port Status (crossed-out directories are handled by Svelte + MDsveX):
TODO: some of these components use onChange
internally, but don't expose externally? Can this be
removed in the Svelte version because it's an implementation detail? Or does it affect the API?
TODO: Use TypeScript
each
blocks)theme: false
)Default Svelte README below:
Looking for a shareable component template? Go here --> sveltejs/component-template
This is a project template for Svelte apps. It lives at https://github.com/sveltejs/template.
To create a new project based on this template using degit:
npx degit sveltejs/template svelte-app
cd svelte-app
Note that you will need to have Node.js installed.
Install the dependencies...
cd svelte-app
npm install
...then start Rollup:
npm run dev
Navigate to localhost:5000. You should see your app running. Edit a component file in src
, save it, and reload the page to see your changes.
By default, the server will only respond to requests from localhost. To allow connections from other computers, edit the sirv
commands in package.json to include the option --host 0.0.0.0
.
To create an optimised version of the app:
npm run build
You can run the newly built app with npm run start
. This uses sirv, which is included in your package.json's dependencies
so that the app will work when you deploy to platforms like Heroku.
By default, sirv will only respond to requests that match files in public
. This is to maximise compatibility with static fileservers, allowing you to deploy your app anywhere.
If you're building a single-page app (SPA) with multiple routes, sirv needs to be able to respond to requests for any path. You can make it so by editing the "start"
command in package.json:
"start": "sirv public --single"
Install now
if you haven't already:
npm install -g now
Then, from within your project folder:
cd public
now deploy --name my-project
As an alternative, use the Now desktop client and simply drag the unzipped project folder to the taskbar icon.
Install surge
if you haven't already:
npm install -g surge
Then, from within your project folder:
npm run build
surge public my-project.surge.sh