Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation for integration #22

Open
4 of 9 tasks
djyde opened this issue Apr 21, 2021 · 43 comments
Open
4 of 9 tasks

Documentation for integration #22

djyde opened this issue Apr 21, 2021 · 43 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers PR welcome

Comments

@djyde
Copy link
Owner

djyde commented Apr 21, 2021

Or if you want to know how does Cusdis intergrate with other services, just leave a comment.

@djyde djyde added documentation Improvements or additions to documentation good first issue Good for newcomers labels Apr 21, 2021
@djyde djyde changed the title Documentation for integrating with other services Documentation for integration Apr 21, 2021
@yizhen666
Copy link

yizhen666 commented Apr 21, 2021

这怎么配合这个项目使用?https://github.com/transitive-bullshit/nextjs-notion-starter-kit

@djyde
Copy link
Owner Author

djyde commented Apr 21, 2021

@wz1616 Hi! I will have a look at notion-starter-kit and write an integrate document for it.

@yizhen666
Copy link

Thank You Very Much!
Waiting For It!

@danisztls
Copy link
Contributor

I integrated it on my Jekyll blog.

PR to upstream theme with the modifications needed.

My Blog

@djyde
Copy link
Owner Author

djyde commented Apr 21, 2021

@lbcnz Awesome!

I read the PR, you properly miss a double quote. I've commented in the PR review.

And in your blog post, the app-id is missing too. Is it because the missing double quote?

@yizhen666
Copy link

@wz1616 Hi! I will have a look at notion-starter-kit and write an integrate document for it.

Have you finished it, please?

@danisztls
Copy link
Contributor

danisztls commented Apr 21, 2021

@lbcnz Awesome!

I read the PR, you properly miss a double quote. I've commented in the PR review.

And in your blog post, the app-id is missing too. Is it because the missing double quote?

Due to sleepiness and lack of testing. I have fixed it.

The quotes are 'optional' as there is no whitespace in the strings but all the variable names were wrong. 😄

@djyde
Copy link
Owner Author

djyde commented Apr 21, 2021

@wz1616 I've finished the document of JS SDK, if you understand how it works, you may know how to integrate it in notion-starter-kit by yourself.

https://cusdis.com/doc#/advanced/sdk

Anyway I will check this later.

@eric-hc
Copy link

eric-hc commented Apr 21, 2021

Would love to see MkDocs with mkdocs-material and Docusaurus added to the list!

@pablopvsky
Copy link
Contributor

I'm working to integrate it into Next JS with SSG, the comments keep fixed when I navigate between screens, if i refresh everything is ok. Would love to see and example of it. Anyway I'm going to keep trying to handle the issue.

@djyde
Copy link
Owner Author

djyde commented Apr 22, 2021

@eric-hc Sure! I don't use python so I'd like to leave MkDocs to the community. But I would try to integrate with Docusaurus.

(Feel free to contribute if someone can do the MkDocs integration. ❤️)

@djyde
Copy link
Owner Author

djyde commented Apr 22, 2021

@pablopvsky Thank you! I think the Docsify plugin implementation would help you

https://github.com/djyde/cusdis/blob/master/public/js/cusdis.docsify.js#L33

I expose a renderCusdis method on window so that the SPA can call it to rerender the widget (Sorry I didn't mention it on the JS SDK document):

https://github.com/djyde/cusdis/blob/master/widget/index.js#L15

@yizhen666
Copy link

现在问题是我不知道该把代码放到哪个文件,还得麻烦您看看> @wz1616 I've finished the document of JS SDK, if you understand how it works, you may know how to integrate it in notion-starter-kit by yourself.

https://cusdis.com/doc#/advanced/sdk

Anyway I will check this later.

@yizhen666
Copy link

您好?请问进度如何了?> @wz1616 I've finished the document of JS SDK, if you understand how it works, you may know how to integrate it in notion-starter-kit by yourself.

https://cusdis.com/doc#/advanced/sdk

Anyway I will check this later.

@djyde
Copy link
Owner Author

djyde commented Apr 24, 2021

@pablopvsky You can check about react-cusdis! https://github.com/Cusdis/sdk/tree/master/packages/react-cusdis

@djyde
Copy link
Owner Author

djyde commented Apr 24, 2021

@wz1616 I just create a PR to nextjs-notion-starter-kit.

If you want to integrate in your existed project, just follow what I did in File Changed https://github.com/transitive-bullshit/nextjs-notion-starter-kit/pull/102/files

@yizhen666
Copy link

真的非常感谢您!辛苦了!
Thank you very much! Thank you for your hard work!

@wz1616 I just create a PR to nextjs-notion-starter-kit.

If you want to integrate in your existed project, just follow what I did in File Changed https://github.com/transitive-bullshit/nextjs-notion-starter-kit/pull/102/files

@djyde
Copy link
Owner Author

djyde commented Apr 24, 2021 via email

@yizhen666
Copy link

Could you provide your repo?

wz1616 @.***>於 2021年4月24日 週六,下午8:32寫道:

I tried again.Here are logs [image: image]
https://user-images.githubusercontent.com/62297116/115958924-21493a00-a53c-11eb-87ba-e1e7eff85660.jpeg>
@wz1616 https://github.com/wz1616 I just create a PR to
nextjs-notion-starter-kit.

If you want to integrate in your existed project, just follow what I did
in File Changed
https://github.com/transitive-bullshit/nextjs-notion-starter-kit/pull/102/files

You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
#22 (comment), or
unsubscribe
https://github.com/notifications/unsubscribe-auth/AAG7HGPTOCB2ZOMZBYR74LDTKK257ANCNFSM43KJZT5A
.

I encountered some problems before, and after checking, I found that it was a code formatting error. It's settled now. thank you.

@djyde
Copy link
Owner Author

djyde commented Apr 24, 2021

@wz1616 Cool! If still have problem in nextjs-notion-starter-kit, you can create a new issue, instead of this issue 😇

@yizhen666
Copy link

Thanks Again!
How About This?https://github.com/djyde/cusdis/issues/49> @wz1616 Cool! If still have problem in nextjs-notion-starter-kit, you can create a new issue, instead of this issue 😇

@YikSanChan
Copy link

@djyde It would be great if it can be integrated with Nextra Blog Theme.

Related nextra issue: shuding/nextra#139

@djyde
Copy link
Owner Author

djyde commented Apr 25, 2021

@djyde It would be great if it can be integrated with Nextra Blog Theme.

Related nextra issue: shuding/nextra#139

shuding/nextra#143 @YikSanChan

@djyde djyde pinned this issue Apr 25, 2021
@scag1io
Copy link

scag1io commented Apr 28, 2021

I integrated Cusdis with my Hugo-generated static site, I configured the code with these parameters:

  data-page-id="{{ .Permalink }}"
  data-page-url="{{ .Permalink }}"
  data-page-title="{{ .Title }}"

It works fine, but I can't get any email for new comments... does it work for you?

@djyde
Copy link
Owner Author

djyde commented Apr 29, 2021 via email

@scag1io
Copy link

scag1io commented Apr 29, 2021

Hosted on Vercel, I cloned your repository yesterday. PostgreSQL DB is self-hosted reachable with DuckDNS.

@djyde
Copy link
Owner Author

djyde commented Apr 29, 2021

Hosted on Vercel, I cloned your repository yesterday. PostgreSQL DB is self-hosted reachable with DuckDNS.

You need to configure SMTP in self-host version. See https://cusdis.com/doc#/features/notification?id=self-host

@scag1io
Copy link

scag1io commented Apr 29, 2021

You need to configure SMTP in self-host version. See https://cusdis.com/doc#/features/notification?id=self-host

I already did it. You mean Vercel Environment Variables, right? I am trying with Gmail:
SMTP_HOST set to "smtp.gmail.com"
SMTP_USER set to "[email protected]"
SMTP_PASSWORD set to an "App password" by Gmail
SMTP_SENDER set to "[email protected]"
I did not set SMTP_PORT and SMTP_SECURE.

The email is not sent when the comment is posted, I can see that the "App password" is not used. Obviously I redeployed the Vercel app.

What should be the correct syntax for HOST? "example.com"?

@djyde
Copy link
Owner Author

djyde commented Apr 29, 2021

You need to configure SMTP in self-host version. See https://cusdis.com/doc#/features/notification?id=self-host

I already did it. You mean Vercel Environment Variables, right? I am trying with Gmail:
SMTP_HOST set to "smtp.gmail.com"
SMTP_USER set to "[email protected]"
SMTP_PASSWORD set to an "App password" by Gmail
SMTP_SENDER set to "[email protected]"
I did not set SMTP_PORT and SMTP_SECURE.

The email is not sent when the comment is posted, I can see that the "App password" is not used. Obviously I redeployed the Vercel app.

What should be the correct syntax for HOST? "example.com"?

This is because Gmail's security settings. See #47 (comment)

@scag1io
Copy link

scag1io commented Apr 29, 2021

This is because Gmail's security settings. See #47 (comment)

Nope, because I tested the credentials with another SMTP tester and it works. I'll do some more tests later.

@djyde
Copy link
Owner Author

djyde commented Apr 29, 2021

This is because Gmail's security settings. See #47 (comment)

Nope, because I tested the credentials with another SMTP tester and it works. I'll do some more tests later.

Feel free to create another issue

@nepofigist
Copy link

Hello everyone,

I'll be the happiest man on Earth if you please share how to use Cusdis with self-hosted blog running on Ghost CMS. Thank you!

@djyde
Copy link
Owner Author

djyde commented May 6, 2021

Hello everyone,

I'll be the happiest man on Earth if you please share how to use Cusdis with self-hosted blog running on Ghost CMS. Thank you!

Hi. Since Ghost uses handlebars, you could translate https://cusdis.com/doc#/advanced/sdk to handlebars syntax.

Or you don't know which variables in Ghost you should use in Cusdis? I can write a tutorial about it.

@nepofigist
Copy link

Hi. Since Ghost uses handlebars, you could translate https://cusdis.com/doc#/advanced/sdk to handlebars syntax.

Or you don't know which variables in Ghost you should use in Cusdis? I can write a tutorial about it.

I found how to use handlebars and everything seems to be okay when I use cloud hosted version. But I don't know how to deploy Cusdis on my own server (not on the Vercel) and without Docker. If you give me some tips, that's gonne be great.

@djyde
Copy link
Owner Author

djyde commented May 6, 2021

Hi. Since Ghost uses handlebars, you could translate https://cusdis.com/doc#/advanced/sdk to handlebars syntax.
Or you don't know which variables in Ghost you should use in Cusdis? I can write a tutorial about it.

I found how to use handlebars and everything seems to be okay when I use cloud hosted version. But I don't know how to deploy Cusdis on my own server (not on the Vercel) and without Docker. If you give me some tips, that's gonne be great.

Oh that's cool. I would write a manually installation guide.

@nepofigist
Copy link

Hi. Since Ghost uses handlebars, you could translate https://cusdis.com/doc#/advanced/sdk to handlebars syntax.
Or you don't know which variables in Ghost you should use in Cusdis? I can write a tutorial about it.

I found how to use handlebars and everything seems to be okay when I use cloud hosted version. But I don't know how to deploy Cusdis on my own server (not on the Vercel) and without Docker. If you give me some tips, that's gonne be great.

Oh that's cool. I would write a manually installation guide.

Thank you very very much :-)

@Edwardzcn
Copy link
Contributor

@eric-hc Sure! I don't use python so I'd like to leave MkDocs to the community. But I would try to integrate with Docusaurus.

(Feel free to contribute if someone can do the MkDocs integration. ❤️)

Hi, I have integrated Cusdis into MkDocs with theme mkdocs-material. According to the docs, I rewrite the discus.html and deploy the Cusdis successfully.

image

Maybe I can write a integrate guide :)

Here is the website

@djyde
Copy link
Owner Author

djyde commented May 10, 2021

@eric-hc Sure! I don't use python so I'd like to leave MkDocs to the community. But I would try to integrate with Docusaurus.
(Feel free to contribute if someone can do the MkDocs integration. ❤️)

Hi, I have integrated Cusdis into MkDocs with theme mkdocs-material. According to the docs, I rewrite the discus.html and deploy the Cusdis successfully.

image

Maybe I can write a integrate guide :)

Here is the website

That's awesome! Could you write a documentation or blog post tutorial for this?

@candideu
Copy link
Contributor

candideu commented Nov 24, 2021

I've integrated Cusdis in Publii. I could create a documentation page. 😃

Edit: here is the PR: #163

@Young-Lord
Copy link
Contributor

Young-Lord commented Aug 2, 2022

@y377
Copy link

y377 commented Feb 18, 2023

jekyll example:

<div class="pt-2" id="cusdis_thread" data-host="https://cusdis.com" data-app-id="See your dashbord on Cusdis" data-page-id="{{ page.id }}" data-page-url="{{ page.url }}" data-page-title="{{ page.title }}">
<!-- If you are a Chinese user, please uncomment this paragraph
    <script type="text/javascript">
    window.CUSDIS_LOCALE = {
        powered_by: '评论由 Cusdis 提供',
        post_comment: '发送',
        loading: '加载中',

        // comment
        email: '邮箱地址 (可选)',
        nickname: '昵称',
        reply_placeholder: '回复内容…',
        reply_btn: '回复',
        sending: '发送中…',

        // reply
        mod_badge: '管理员',
        content_is_required: '内容不能为空',
        nickname_is_required: '昵称不能为空',

        comment_has_been_sent: '评论已发送,管理员审核通过后会展示',
    }
    </script> -->
    <script async defer src="https://cusdis.com/js/cusdis.es.js"></script>
</div>

Put this code into the layout of the post (usually at the bottom of the page), the post will automatically generate a different url and id and title when the layout is applied, so there will not be a comment repeatedly displayed in the same page

@Young-Lord
Copy link
Contributor

you should use official translation instead of writing by yourself. My sample is below.

@BeeBombshell
Copy link

Oops, seeing this now! @djyde, I created an issue for docs enhancement for Docusaurus integration in #266. Here's a question on StackOverflow about Cusdis X Docusaurus integration that I answered a while back. If this is the correct approach, let me know and I can add a PR for this 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers PR welcome
Projects
None yet
Development

No branches or pull requests