https://github.com/andrew-bedford/re-blog

Simple webassembly-based blog
https://github.com/andrew-bedford/re-blog

blazor blog csharp webassembly

Last synced: about 1 month ago
JSON representation

Simple webassembly-based blog

• Host: GitHub
• URL: https://github.com/andrew-bedford/re-blog
• Owner: andrew-bedford
• License: mit
• Created: 2024-01-02T18:03:58.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-11-02T02:31:17.000Z (3 months ago)
• Last Synced: 2024-11-11T17:14:02.403Z (3 months ago)
• Topics: blazor, blog, csharp, webassembly
• Language: HTML
• Homepage: http://blog.andrew-bedford.ca
• Size: 1.91 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# re/blog

A simple client-side markdown blog engine, built for fun!

Choosing WebAssembly for a blog may appear strange, after all most search engines would have difficulty indexing its content, but this is actually a feature of re/blog. It is perfect for those who want to maintain a public blog, perhaps for their friends and family, while still retaining some privacy by making it less discoverable. It also has the advantage of being deployable to static file hosts like GitHub Pages.

If you are interested in making it more search engine-friendly, one option would be to convert your re/blog into a hosted application and enabling server-side prerendering. Or adding a post-build task that generates a `sitemap.xml` file.

## Features

Clean default interface with a content navigation pane, which allows users to skip to specific sections.

![](wwwroot/images/interface.png)

Navigate posts using a timeline, previous/next buttons, or left/right keyboard arrows.

![](wwwroot/images/timeline.png)

## Usage

Add markdown files to the `wwwroot/posts` folder and update `index.json`. Posts are expected to have the following YAML header:

```

---

id: lorem-ipsum

title: Lorem Ipsum

abstract: Optional abstract

created: 2024-01-01

tags: tag1, tag2

---

```

Where `id` corresponds to the url slug to be used, so it should not contain any spaces.

After customizing `Pages/Index.razor` (e.g., specifying avatar), the blog can be published using:

```

dotnet publish

```

For development:

```

dotnet watch run

```

## Hosting

Since this is a WebAssembly application that runs entirely on the client-side, it can be hosted pretty much anywhere. Note however that for direct links to work, the server's 404 page must point to the blog's `index.html`. This is due to the way that Blazor WebAssembly does routing (see [Host and deploy ASP.NET Core Blazor WebAssembly](https://learn.microsoft.com/en-us/aspnet/core/blazor/host-and-deploy/webassembly?view=aspnetcore-8.0#rewrite-urls-for-correct-routing) for explanation).

Here is how this can be done using nginx and apache httpd.

### nginx

```

server {

    listen 80;

    server_name blog.url.com;

    root /path/to/blog/wwwroot;

    index index.html;

    error_page 404 /index.html;

    location / {

        try_files $uri $uri/ =404;

    }

}

```

### httpd

Using a `.htaccess` page:

```

ErrorDocument 404 /index.html

```

## Tasks

 - [ ] Add build tasks that would make it easier to publish/deploy the blog.

 - [ ] Create global configuration file to allows users to do things such as set the avatar image, blog name.

 - [ ] Add a plugin system that would allow users to easily customize it.

 - [ ] (?) Add metainformation panel.

 - [ ] (?) Add support for comments.