Heading post to discourse for GitBook

This plugin allows you to synchronise content to discourse.

Installation

Install as a global NodeJs package.

$ npm install -g gitbook-plugin-discourse

Use in a gitbook

To use in your book, add to plugins list in book.json in your gitbook directory:

{
    "plugins": ["discourse"]
}

Configuration

You can configure the plugin is book.json:

{
    "pluginsConfig": {
        "discourse": {
            "url": "DISCOURSE_URL",
            "api_key": "API_KEY",
            "api_username": "API_USERNAME",
            "parent_category_id": PARENT_CATEGORY_ID,
            "parent_category_name": "PARENT_CATEGORY_NAME"
        }
    }
}

you can also set environment var API_KEY=xxxx and keep config value empty like "api_key": "".

Finding parent_category_id

Once you create a category, it'll have an URL like https://talk.vtaiwan.tw/c/6-category.json — the 6 is the ID.

If you have assigned the category a short name, such as https://talk.vtaiwan.tw/c/personal-data-protection, add a .json to the URL and see https://talk.vtaiwan.tw/c/personal-data-protection.json for the category_id field (which is 22 in this example.)

Licence

MIT

Requests

Contributions welcome, of course!