https://github.com/xfenix/raml2html-comment-template

This is raml2html theme fork with embeded Disqus comments for each sections (if you want to comment your api, but doesnt want to pay for swagger, anypoint etc.)
https://github.com/xfenix/raml2html-comment-template

raml raml2html raml2html-disqus raml2html-theme

Last synced: 4 months ago
JSON representation

This is raml2html theme fork with embeded Disqus comments for each sections (if you want to comment your api, but doesnt want to pay for swagger, anypoint etc.)

• Host: GitHub
• URL: https://github.com/xfenix/raml2html-comment-template
• Owner: xfenix
• License: mit
• Created: 2018-02-06T14:21:17.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2018-08-27T10:09:27.000Z (almost 8 years ago)
• Last Synced: 2025-06-27T04:51:20.770Z (12 months ago)
• Topics: raml, raml2html, raml2html-disqus, raml2html-theme
• Size: 415 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# raml2html disqus comments template

This template allows you to add comments for you methods in raml

This is not theme (i am sucks at nodejs packaging, so), this is template directory and first of all just a fork from raml2html-default-theme with some additions. So you can use it like template  

Replace language strings with you language if you doesnt know/like/use Russian language: [row 252](https://github.com/xfenix/raml2html-comment-template/blob/master/index.nunjucks#L252), [row 302](https://github.com/xfenix/raml2html-comment-template/blob/master/index.nunjucks#L302), [row 325](https://github.com/xfenix/raml2html-comment-template/blob/master/index.nunjucks#L325) in `index.nunjucks`  

**WARNING!** All comments binded to unique resource id (that generates from your resource url). So you comments will be available while you dont change the resource id. This is only way to bind dynamic comments to static html. I hope this will be helpful for someone

Screenshots:

* Closed comment section ![](./images/closed.png)

* Opened comment section ![](./images/opened.png)

## Installation

1. Clone this repo

1. Register new disqus comments instance for your domain

1. Open index.nunjucks and replace ``YOUR_DISQUS_DOMAIN`` with your disqus domain (you get it while diqsus registration)

1. Generate documentation from raml like this ``raml2html --template raml2html-comments-template/index.nunjucks api.raml > index.html``

1. Use you new shiny documenation with comments

1. ???

1. Profit