Skip to content

Commit 6f9dcaf

Browse files
authored
Merge pull request #101 from bemanproject/blogpost/docs
Update docs for creating blogpost with instructions for enabling the Discourse plugin
2 parents d8aa94a + 23fc322 commit 6f9dcaf

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ $ cat blog/2000-10-30-my-blog-example/index.md
3333
slug: my-blog-example-slug # Slug example. Remove this comment if using this template.
3434
authors: [neatudarius] # Authors list with entrie from blog/authors.yml. Remove this comment if using this template.
3535
tags: ["cpp26", "beman-docs"] # Blog post valid tags from blog/tags.yml. Remove this comment if using this template.
36+
comments: true # If comments should be enabled for this blog post. Default: true.
3637
---
3738

3839
# My Blog Example
@@ -63,6 +64,8 @@ socials: # [optional] Include your socials (like your Github, X, Linkedin
6364

6465
</details>
6566

67+
> Note: The Discourse comments plugin only works for production website (a.k.a. https://bemanproject.org/). You cannot test it locally or on preview deployments. Check [Integrate Discourse comment feature for blog posts](https://github.com/bemanproject/website/issues/25) for more details.
68+
6669

6770
4. Open a `DRAFT PR` and `wait` up to one minute for a preview deployment of your blog post.
6871

0 commit comments

Comments
 (0)