codex/comments

Codex Addon - Adds comments to your documents like Disqus or create your own adapter

dev-master / 2.1.x-dev 2019-04-27 07:24 UTC

Requires

• codex/core: ~2.0

Suggests

• codex/algolia-search: Integrates algolia search into codex (~2.0)
• codex/auth: Provides authentication using oauth providers (socialite) to restrict project access (~2.0)
• codex/blog: Provides blogging capability with categories containing posts (~2.0)
• codex/filesystems: Adds a collection of common filesystem adapters. These can be used by your projects. (~2.0)
• codex/git: Enables Github/Bitbucket integration & synchronisation (auto-webhook or manual) based on tags/branches. (~2.0)
• codex/packagist: Integrates Packagist information links and macros in your projects (~2.0)
• codex/phpdoc: Integrates PHPDoc documentation, links and macros in your projects (~2.0)
• codex/sitemap: Generates a sitemap.xml (~2.0)

MIT

• Robin Radic

• documentation
• markdown
• comments
• disqus
• laravel
• codex
• reactions

README

Comments Addon

Adds comments to your documents. The addon uses adapters to provide Codex with a comment system. You can either use one of the included adapters or use a custom adapter.

Includes the following adapters:

• Disqus

Installation

composer require codex/comments
php artisan codex:addons:enable codex/comments

Configuration

config/codex-comments.php

[
    'default' => 'disqus',
    'connections' => [
        'disqus' => [
            'driver'    => 'disqus',
            'shortcode' => 'codex-project',
        ],
    ],
]

[project]/config.php [project]/[revision]/revision.yml [project]/[revision]/[document] (as attributes)

[
    'processors' => [
        'enabled' => [
            // ...
            'comments' => true
        ],
        'comments' => [
            'enabled' => true,
            'connection' => 'disqus' 
        ]
    ]
]

Creating a custom adapter

Copyright/License

Copyright 2019 Robin Radic - MIT Licensed