Lynx

Writing Blog Posts

The Lynx website hosts a blog to share updates, tutorials, and announcements.

Location

All blog posts are located in docs/en/blog/.

Creating a New Post

  1. Create a new .mdx file in docs/en/blog/. The filename will be part of the URL.
  2. Add the necessary frontmatter.
---
title: My New Blog Post
date: 2024-01-01
author: Your Name
description: A short summary of the post.
---
  1. Write your content using standard Markdown and MDX components.

Blog Components

We provide specialized components for blog listings and author avatars.

<BlogList>

Renders the list of blog posts automatically.

import { BlogList } from '@lynx';

<BlogList limit={1} />;

<BlogAvatar>

Renders avatars for blog authors.

You can add new authors in src/components/blog-avatar/authors.json.

import { BlogAvatar } from '@lynx';

<BlogAvatar list={['lynx']} />;
The Lynx Team
The Lynx Teamlynxjs.org

Blog Index

The blog index is automatically generated. Ensure your date field is correct so posts are ordered chronologically.

Images

Place images in the public/ directory or relative to the blog post if configured.

Except as otherwise noted, this work is licensed under a Creative Commons Attribution 4.0 International License, and code samples are licensed under the Apache License 2.0.