shcahill/Coupage

Coupage 📚

Why is it called Coupage?

Confluence Unique Page Generator 📚🤪

---

💡 Installing

$ git clone https://github.com/Kota4822/Coupage.git
$ cd Coupage
$ make

Make resources directory

$ cd "outputPath"
$ coupage init

Resources

.coupage
├── templates
│   ├── sample
│   │     ├── page_config.yml
│   │     └── template.tpl
│   └── templateA
│         ├── page_config.yml
│         └── template.tpl
└── user_config.yml(Optional)

• user_config.yml
  • id: confluence user id
  • apiKey: confluence user APIKey
• .coupage/templates/templateName
  • Template name to use. As many as you like.
• templateName/page_config.yml
  • url: target confluence base url
  • default_space_key: confluence spaceKey to generate page(optional)
  • default_ancestors_key: confluence ancestorsKey to generate page(optional)
• templateName/template.tpl
  • Confluence PageTemplate. (Confluence REST API examples)
  • In the template, write as {{ReplaceKey}}. Replacing according to the parameters.

  $ coupage ReplaceKey:Value aaa:bbb ...

---

📚 Usage

Generate page

$ coupage run pageTitle:XXX templateName:XXX

• Requied Parameter

  • pageTitle: page title

  • templateName: template name to use

• Optional Parrameter

  • userId: Confluence User Id
  • apiKey: Confluence User ApiKey
  • spaceKey: spaceKey to output(optional：If not in the parameter, use page_config.yml.)
  • ancestorsKey: ancestorsKey to output(optional：If not in the parameter, use page_config.yml.)
  • template ReplaceKey and Values