Publishing and Embedding

PUBLISH BUTTON

The first step to getting your Haiku out into the world is to publish it.

You'll find a button on the top-right of project editor that does just that.

Simply press PUBLISH and your up-to-the-moment work will be shuttled out to the cloud and packaged up for use in any codebase. We then give you a unique link (think of it like a Google Docs link) that you can share with colleagues.

That link will take you to your Haiku's Share Page: see below.

Note on publish speed: Depending on your connection speed and place in the world, publishing can currently take a little while, between 5 seconds and 2 minutes. We're working on making this faster. Once when we have realtime collaboration hooked up, publishing should be seamless and nearly immediate.


SHARE PAGE

The Share Page is your entry point for sharing Haiku. You can see and interact with your Haiku, share it with your colleagues, and even share it easily on social media.

How to Use

Key on the Share Page is the "How to Use" button on the bottom-right. If you click that button, the bottom panel expands and explains exactly how to use your Haiku in a number of different codebases, including vanilla HTML (embed,) vanilla JS, React, and more.

Embed in any webpage or web app

HTML Embed

From the Share Page "How to Use" menu, select the HTML Embed option, then copy and paste the snippet anywhere you'd like. Here's an example of an HTML embed in CodePen: https://codepen.io/anon/pen/EXQZEb

React Component

From the Share Page "How to Use" menu, select the React option, then follow the instructions to install the CLI (More info here: Using the Haiku CLI)

Then from the command line, inside your React project, run haiku install YourProjectName. Behind the scenes, this simply runs npm install, and sets up your environment to pull that component from the correct server.

Important: the haiku install command will create or modify a file called .npmrc in your project. It's important that you check this into your version control, otherwise other teammates will not be able to install your Haiku components.


ACCESSING THE RAW CODE

~/.haiku Folder

When you open any project with Haiku on your desktop, the project files are copied to your filesystem at this location: ~/.haiku/projects/YOUR_ORG/YOUR_PROJECT

haiku clone

You can also clone down a project directly to any location of your choosing. You can do this with the haiku clone YourProject command, which uses git clone behind the scenes. First, you need to install the Haiku CLI, see: Using the Haiku CLI


Next: Using the Haiku CLI

results matching ""

    No results matching ""