An open API service indexing awesome lists of open source software.

https://github.com/chainbound/blog

The Chainbound blog
https://github.com/chainbound/blog

Last synced: 5 months ago
JSON representation

The Chainbound blog

Awesome Lists containing this project

README

          

# Chainbound Blog

This is a Next.js application generated with
[Create Fumadocs](https://github.com/fuma-nama/fumadocs).

Run development server:

```bash
bun dev
```

Open http://localhost:3000 with your browser to see the result.

Format the code:

```bash
bun format
```

Test a full build:

```bash
bun run build
```

## Content

Blog contents are stored in the [`content/blog`](content/blog) directory. Each
blog post is an MDX file with the following frontmatter:

```yaml
title: 'Some Title'
authors: [author1, author2]
date: YYYY-MM-DD
tags: [tag1, tag2]
# Metadata image, relative to public/
card: /path/to/image.png
# Display on home page or not
hidden: false
```

### Authors

Authors are defined in the [`lib/authors.ts`](src/lib/authors.ts) file.

### Images

To add images to a blog post, create a directory with the same name as the blog
post in the [`public`](public) directory. Then you can reference the image in
the blog post using the following syntax:

```mdx
![](//image.png)

Caption for the image
```

## Deployment

The blog is deployed to Vercel on every push to the `main` branch.

Before deploying, run the following checklist:

- `bun format` to format the codebase and MDX files.
- `bun run build` to build the project, this can fail even if `bun dev` works.
- Spell check your newly added blog posts with an LLM tool.

## Fuma Docs

### Explore

In the project, you can see:

- `lib/source.ts`: Code for content source adapter,
[`loader()`](https://fumadocs.dev/docs/headless/source-api) provides the
interface to access your content.
- `lib/layout.shared.tsx`: Shared options for layouts, optional but preferred to
keep.

| Route | Description |
| ------------------------- | ------------------------------------------------------ |
| `app/(home)` | The route group for your landing page and other pages. |
| `app/docs` | The documentation layout and pages. |
| `app/api/search/route.ts` | The Route Handler for search. |

### Fumadocs MDX

A `source.config.ts` config file has been included, you can customise different
options like frontmatter schema.

Read the [Introduction](https://fumadocs.dev/docs/mdx) for further details.