docs

Meltano Documentation

Read more at meltano.com.

Prerequisites

Before you move on, make sure you have Node 8.x or newer installed.

Instructions

1. Clone the project

git clone [email protected]:meltano/meltano.git

2. Navigate to the docs/ folder and install all dependencies

cd meltano/docs/
npm install

3. Build and run

npm run dev:docs

4. View changes at http://localhost:8080/

Build Artifacts

To generate static assets for the docs/ directory, run:

npm run build:docs

This will add the generated files in the docs/public directory.

FAQs

1. How do I add screenshots?

• Place the images in /docs/.vuepress/public.
• Use Markdown image syntax ![imageAltText](imageUrl)