Remark42

Remark42 is a ** lightweight, fast and safe ** open source comment system that can be easily embedded into any website. ###Core Features - ** Various OAuth certifications **: Support GitHub, Google, Facebook, Twitter, Yandex, etc. - **Markdown support **: Complete Markdown formatting capabilities - ** Image upload **: Upload images in support comments - ** Voting System **: Support likes/comments - ** Comment review **: Administrators can review, edit, and delete comments - ** Anonymous comments **: Optional enable anonymous comments - ** Multi-language support **: Support Chinese, English and other languages - ** Responsive design **: Perfect for desktop and mobile devices - ** Data import and export **: Support backup and migration - ** Comment notifications **: Configurable email and Telegram notifications ### 1. Visit the presentation page After installing the application, directly visit your application domain name to see the demonstration page: ``` https://Your application domain name/ ``` The presentation page contains: - ** Comment component demonstration ** -Complete comment system at the bottom of the page - ** Latest Comments Widget ** -Displays a list of latest comments - ** Comment Counter ** -Displays the number of comments - ** Theme switching ** -Light and dark theme switching function ### 2. Configure OAuth certification (required) To allow users to log in and post comments, ** at least one OAuth provider must be configured **. ####Easiest: Using GitHub OAuth 1. ** Visit GitHub to create the OAuth App**: - Log in to GitHub - Visit https://github.com/settings/developers - Click on "New OAuth App" 2. ** Fill in application information **: ``` Application name: Remark42 Comment System Homepage URL: https://Your application domain name/ Authorization callback URL: https://your application domain name/auth/github/callback ``` 3. ** Get voucher **: - After creation, you will get Client ID and Client Secret - Save these two values 4. ** Configure it to Lazy Cat Micro Service **: Set environment variables through the Lazy Cat Microservice console or CLI: ```bash #Using CLI lzc-cli app env set <app-id>AUTH_GITHUB_CID= your Client_ID lzc-cli app env set <app-id>AUTH_GIFIHUB_CSEC= Your Client_Secret ``` Or add to the application environment variables in the console: ``` AUTH_GITHUB_CID = Your Client_ID AUTH_GITHUB_CSEC = Your Client_Secret ``` 5. ** Restart the application **: ```bash lzc-cli app restart <app-id> ``` Once completed, users can log in and comment using their GitHub account! ##Embed into your website ###Basic embedding code Add the following code to your website page to display the Remark42 comment component: ```html <!-- 第一步：添加评论容器 --> <div id="remark42"></div> <!-- 第二步：添加配置和加载脚本 --> <script> var remark_config = { host: 'https://your application domain', site_id: 'remark', components: ['embed'], }; (function(c, d) { for (var i = 0; i < c.length; i++) { var s = d.createElement('script'); s.src = remark_config.host + '/web/' + c[i] + '.js'; s.async = true; s.defer = true; (d.head || d.body).appendChild(s); } })(remark_config.components || ['embed'], document); </script> ``` ###Get the latest comments ```bash GET https://your application domain name/api/v1/last/10? site=remark ``` ###Get the number of comments ```bash #Single URL GET https://your application domain name/api/v1/count? site=remark&amp;url= article URL #Multiple URLs POST https://Your app domain name/api/v1/counts? site=remark Content-Type: application/json ["URL1", "URL2", "URL3"] ``` ###Leave a comment (certification required) ```bash POST https://Your application domain name/api/v1/comment Content-Type: application/json Authorization: Bearer JWT_TOKEN { "text": "Comment content", "locator": { "site": "remark", "url": "Article URL" } } ``` ###Administrator API (requires administrator privileges) ```bash #Delete comments DELETE https://your application domain name/api/v1/admin/comment/{comment_id}? site=remark Authorization: Bearer JWT_TOKEN #Export data GET https://your application domain name/api/v1/admin/export? site=remark&mode=full Authorization: Bearer JWT_TOKEN ```