0.1.0 • Published 7 years ago

ssod v0.1.0

Weekly downloads
1
License
MIT
Repository
-
Last release
7 years ago

SSOD

Singe source of documentation for projects using confluence.

SSOD automatically uploads markdown files to Confluence.

Installation

$ npm install ssod --save-dev

Configuration

Create a .ssodrc file in your project directory, with the following structure:

{
  "source": ".",
  "ignore": ["node_modules", ".git"],
  "confluence": {
    "username": "your-username-here",
    "password": "your-password-here",
    "spaceKey": "FOO",
    "baseUrl": "https://your-sub-domain.atlassian.net/wiki",
    "rootPage": 1234
  }
}
  • source optional is the relative path, from cwd, that SSOD uses to start the file search.
  • ignore optional lists the name of files or folders that will be ignored in the search.
  • rootPage is the ID of the page under with pages will be uploaded.

Usage

Just run the main executable from your project directory:

$ node node_modules/.bin/ssod

License

MIT