Blogging Tactics

Here are some suggestions for how to create the class blog posts for your assigned classes.

Fork the github repository for the course website.

• This is what is used to build the https://qiyanjun.github.io/2024sp-GenAI-Risk-Benefits/ site. If you are working with multiple teammates on the blog post (which you probably should be), you can add write permissions for everyone to the forked repository.

• You should find your page in the _contents/ subdirectory.
• I have a simple version of each session’s *.md

• Please find the right one for your blogging session and updating it with your content.

• You can use multiple files (but probably only one in the _contents/ directory (this will show up as pages on the front list). For instance, Use the folder docs/images/ directory for images. Using images and other resources to make your post interesting and visually compelling is highly encouraged!

• Write the blog page using Markdown. Markdown is a simple markup language that can be used to easily generate both HTML and other output document formats. You can probably figure out everything you need by looking at previous posts, but for a summary of Markdown, see Markdown: Syntax.

• The lead team’s slide deck is your best guide for the blogging contents. One toolkikt converting pptx to MD help you reduce workload when blogging https://github.com/ssine/pptx2md

• Please pay extra attention on the folder structure for hosting images.. and how to cite images in a markdown MD file through markdown variable on site-URL

• You can incorporate latex math into your markdown. Use \( inline \) for inline math, e.g., \( J_{min}\} and \(...\) for display math.

• Your post should include credits for any external material you use, especially for any images you incorporate that you didn’t produce.

• Please include full references to the papers, and links to the most definitive source available (usually this is to arxiv or a conference site, but could be the author’s page). You should include additional links to relevant and useful reference or code repositories. Its good to have an overview section at the beginning of the post with links to all the main papers covered, and then to have links in specific sections to what is being covered.

• When you are ready, submit a pull request to incorporate your changes into the main repository (and public course website). Also, send a message to me, so I know the post is ready to review. At this stage, I will probably make some requests for improvements, and then will post the edited version to the course site.

About the course website

• This site is generated by Jekyll + PostTagging .

A list of easy steps setting up Jekyll GitPage

1. set up ruby: please follow the step from steps for mac version

2. install jekyll

   ~ $ gem install jekyll
   

3. About minimal-mistakes theme https://mmistakes.github.io/minimal-mistakes/docs/quick-start-guide/#installing-the-theme

• and layout

1. now deploy it locally

   ~/web-name $ bundle install
   ~/web-name $ bundle exec jekyll serve
   

   Now use your favorite browser to open http://localhost:4000

---

Troubleshooting

If you have a question about using Jekyll, start a discussion on the Jekyll Forum or StackOverflow. Other resources:

• Ruby 101
• Setting up a Jekyll site with GitHub Pages
• Configuring GitHub Metadata to work properly when developing locally and avoid No GitHub API authentication could be found. Some fields may be missing or have incorrect data. warnings.