@labset/confluence-website v0.2.1

confluence-website

install it

• with npm

npm install @labset/confluence-website --save-dev

• with yarn

yarn add @labset/confluence-website -D

configure your site

./node_modules/.bin/confluence-website init-env

it creates a .env file with the following properties

• CONFLUENCE_SITE_NAME : the Confluence cloud instance you want to generate a site from (name.atlassian.net)
• CONFLUENCE_USERNAME : the username to use to consume Confluence APIs
• CONFLUENCE_API_TOKEN : the user personal access token to consume Confluence APIs
• CUSTOM_DOMAIN : the domain name of where your generated site will be hosted

./node_modules/.bin/confluence-website init-site

it creates a .confluence-website.json file with the following configuration

{
  "title": "confluence-website",
  "iconUrl": "",
  "name": "space name",
  "theme": {
    "name": "confluence-website",
    "backgroundColor": "rgb(0, 102, 68)",
    "highlightColor": "#FFFFFF"
  }
}

extract your site content

./node_modules/.bin/confluence-website extract-space <spaceKey>

build your site

./node_modules/.bin/confluence-website build-space <spaceKey>