https://github.com/kerollmops/blog

A chill and fun blog about Rust stuff and the journey of building my company: Meilisearch
https://github.com/kerollmops/blog

blog continuous-integration github rust tiny-utterances

Last synced: about 1 month ago
JSON representation

A chill and fun blog about Rust stuff and the journey of building my company: Meilisearch

• Host: GitHub
• URL: https://github.com/kerollmops/blog
• Owner: Kerollmops
• License: mit
• Created: 2023-08-09T18:30:57.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-11-08T10:08:22.000Z (about 2 months ago)
• Last Synced: 2024-11-08T11:20:10.553Z (about 2 months ago)
• Topics: blog, continuous-integration, github, rust, tiny-utterances
• Language: Rust
• Homepage: https://blog.kerollmops.com/
• Size: 7 MB
• Stars: 10
• Watchers: 2
• Forks: 1
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# blog

My personal blog website

## Simple Usage

You must first specify the GitHub repository identifier by using the `GITHUB_REPOSITORY` var, the `EMAIL_ADDRESS`, and preferably your `GITHUB_TOKEN`. You can find more information on the token on [the action it is used by](https://github.com/peaceiris/actions-gh-pages).

```bash

export GITHUB_REPOSITORY=Kerollmops/blog

export EMAIL_ADDRESS=your-wonderful-email-address

export GITHUB_TOKEN=your-github-token

```

Once you are ready you can run the program and you'll notice a new `output/` folder with all the files.

```bash

cargo run

```

## Advanced Tricks

### Defining the Post Synopsis

This blog tool uses HTML comments to let you define the synopsis visible on the homepage of the blog website.

```markdown

This is the first sentence of my blog post and this will only be visible in the article.

```

### Using Tiny-Utterances to Display Comments

I decided to use [tiny-utterances to display the user comments](https://cofx22.github.io/tiny-utterances/) under the blog post. It's a [simplified version of Utterances](https://utteranc.es/) and works great. The only thing is the hardcore GitHub rate-limiting on the API.