A self-hostable CMS-like proxying Cohost posts
Go to file
Jill 5fd335bbf5
fallback to cache if networking fails
2023-08-20 04:02:43 +03:00
src fallback to cache if networking fails 2023-08-20 04:02:43 +03:00
static init 2023-04-30 19:33:37 +03:00
.eslintignore init 2023-04-30 19:33:37 +03:00
.eslintrc.cjs init 2023-04-30 19:33:37 +03:00
.gitignore init 2023-04-30 19:33:37 +03:00
.npmrc init 2023-04-30 19:33:37 +03:00
LICENSE license under GPL-3.0 2023-05-14 03:01:35 +03:00
README.md use relative paths for readme links 2023-05-18 07:14:08 +03:00
flake.lock flake: bump nixpkgs to 23.05 2023-06-02 00:13:06 +03:00
flake.nix bump some versions 2023-08-20 03:49:01 +03:00
jsconfig.json init 2023-04-30 19:33:37 +03:00
package-lock.json bump some versions 2023-08-20 03:49:01 +03:00
package.json bump some versions 2023-08-20 03:49:01 +03:00
svelte.config.js init 2023-04-30 19:33:37 +03:00
vite.config.js init 2023-04-30 19:33:37 +03:00

README.md

cohost-blogger

A self-hostable front-end for Cohost mimicing a CMS.

What?

CMSes are stupid to host, stupid to make and stupid to find. Why bother? We have a perfectly fine Cohost. Let's use that!

This site, pointed at a Cohost user and tag, will find every post under that tag and display it in a nice way, including the comments and proper rendering of the contents themselves.

How?

If you're on NixOS, you should be able to integrate it into your system config as a flake or just run it with nix run.

First, install the dependencies:

git clone https://git.oat.zone/oat/cohost-blogger && cd cohost-blogger
npm install

Afterwards, for development, you can run:

npm run dev

Or, for deployment:

npm run build
PORT=1234 node build

Configuration

Currently, there isn't a proper configuration system - this is not yet made to be hosted by anyone by me. You can head into src/lib/config.js for all instance-specific configuration, but this will be expanded into a proper system eventually™️.

Writing notes

There are a few different quirks from Cohost's official parser you must keep in mind:

  • Most sanitization rulesets do not apply to posts
    • This means that classes and other otherwise removed attributes are kept
      • Classes are isolated in the app, however, so don't be afraid of using classes if you must
    • They still apply to comments
  • Isolation is a bit more loose
  • The background of the post can be dark depending on the user's theme

Cohost-exclusive content

You may specify Cohost-exclusive content like so:

<div class="cohost-blogger-ignore">
  Everything inside of here is hidden on cohost-blogger!
</div>

Metadata

cohost-blogger metadata may be specified like so:

<!--@cohost-blogger-meta
slug: so-how-are-there-eyes-in-the-water-exactly
published-at: 2023-01-24
-->

It may be inserted at any point in the post, as long as it is a seperate block - prepended and appended with 2 newlines.

Currently, only slug and published-at are valid keys, however more may be added in the future. slug specifies the URL, while published-at overrides the publication date for reuploaded posts.

Videos

Currently, only direct links and YouTube links are supported as videos. You embed them the same way you do on Cohost - by putting them in plaintext in their own paragraph.

Direct link videos autoplay. This may start playing audio in certain cases! Please append ?autoplay=false to video URLs with sound.

Development notes

Markdown processing

Most Markdown processing code is borrowed from Cohost itself. You can download its partial source code from its sourcemaps, if you wish to reference it

Nix Flake NPM dependencies

Each time you add, remove or otherwise modify an NPM dependency, you must update the hash in the Nix Flake:

  1. Replace the dependency hash in flake.nix with a fake one:

    npmDepsHash = pkgs.lib.fakeHash;
    
  2. Run nix run to attempt to build the package. It will fail, giving you an error that looks like this:

    error: hash mismatch in fixed-output derivation '/nix/store/h6s1rmcyrllqgqmrmhgmzgf2xkhws20r-cohost-blogger-0.0.1-npm-deps.drv':
         specified: sha256-AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=
            got:    sha256-hzn0sjxcysxe++IPyhKE/syx3S1Nh2hKGcjvS6UaLvY=
    
  3. Replace the dependency hash with the expected hash:

    npmDepsHash = "sha256-hzn0sjxcysxe++IPyhKE/syx3S1Nh2hKGcjvS6UaLvY=";
    

Attributions