idyll-langidyll
DocsTutorialsGalleryEditor
menu

Overview

  • Introduction
  • Getting started
  • Markup syntax
  • HTML tags
  • Options and styles
  • Plugin system
  • Multipage template

Interactivity

  • Built-in components
  • Using components from npm
  • Make your own component
  • Scrolling and Refs

Publishing

  • Deploying to the web
  • Embedding Idyll

Useful Links

  • Github
  • Chat
  • Twitter
  • Support Us

Building your Idyll project for the web

Once you are happy with your project, the idyll command-line tool can also be used to build a stand alone bundle. If you used the Idyll project generator, npm tasks to build and deploy the project to github pages are available.

idyll.pub

Once you've initialized your project, run the commands

$ idyll build
$ idyll publish

this will compile the assets and then publish it on the idyll.pub server. Note that the meta component is useful for inserting metadata into the compiled output.

If you wish to update the post, simply rerun the idyll publish command.

Note: running idyll publish does not automatically rebuild your project.

Other hosting

Idyll's generated output is compatible with other static hosting services as well.

To compile the project, run

$ idyll build

this will compile files and place them inside of the build/ folder.