https://github.com/2wce/blog
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/2wce/blog
- Owner: 2wce
- License: mit
- Created: 2025-02-24T19:11:18.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-25T14:35:18.000Z (about 1 year ago)
- Last Synced: 2025-10-25T05:56:06.998Z (8 months ago)
- Language: XSLT
- Homepage: https://blog-lake-mu-98.vercel.app
- Size: 683 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Slate blog
## Why We build it?
We love writing and sharing, and we appreciate well-crafted products. That’s why we created this minimalist theme, focusing on content itself, providing a smooth and pure writing and reading experience. Built on the latest framework, it’s faster, lighter, and more efficient.
It also works seamlessly with [Obsidian](https://obsidian.md/), helping you turn your notes into published posts effortlessly.
## ✨ Features
- Minimalist style theme, adaptable to multiple platforms
- Support `light` and `dark` mode.
- Zero-based quick start, foolproof configuration, easy deployment
- Support for article drafts, local preview, and automatic draft filtering in production builds
- Default RSS generation with Follow subscription authentication
- Integrated Algolia search
- Complete SEO optimization to improve search engine rankings
## 🪜 Framework
- Astro + React + Typescript
- Tailwindcss + @radix-ui/colors
- Updated to [Tailwind CSS v4.0](https://tailwindcss.com/blog/tailwindcss-v4) (Jan 10, 2025)
- Docsearch
## 🔨 Usage
```bash
# Start local server
npm run dev
# or
yarn dev
# or
pnpm dev
# Build
npm run build
# or
yarn build
# or
pnpm build
```
> If you fork the repository and set it to private, you will lose the association with the upstream repository by default. You can sync the latest version of Slate Blog by running `pnpm sync-latest`.
## 🗂 Directory Structure
```
- plugins/ # Custom plugins
- src/
├── assets/ # Asset files
├── components/ # Components
├── content/ # Content collections
├── helpers/ # Business logic
├── pages/ # Pages
└── typings/ # Common types
```
> Articles are stored in the `src/content/post` directory, supporting markdown and mdx formats. The filename is the path name. For example, `src/content/post/my-first-post.md` => `https://your-blog.com/blog/my-first-post`.
## Configuration
Theme configuration is done through `slate.config.ts` in the root directory.
| Option | Description | Type | Default |
| --- | --- | --- | --- |
| site | Final deployment link | `string` | - |
| title | Website title | `string` | - |
| description | Website description | `string` | - |
| lang | Language | `string` | `zh-CN` |
| theme | Theme | `{ mode: 'auto' \| 'light' \| 'dark', enableUserChange: boolean }` | `{ mode: 'auto', enableUserChange: true }` |
| avatar | Avatar | `string` | - |
| sitemap | Website sitemap configuration | [SitemapOptions](https://docs.astro.build/en/guides/integrations-guide/sitemap/) | - |
| readTime | Show reading time | `boolean` | `false` |
| lastModified | Show last modified time | `boolean` | `false` |
| algolia | Docsearch configuration | `{ appId: string, apiKey: string, indexName: string }` | - |
| follow | Follow subscription authentication configuration | `{ feedId: string, userId: string }` | - |
| footer | Website footer configuration | `{ copyright: string }` | - |
| socialLinks | Social Links Configuration | `{ icon: [SocialLinkIcon](#SocialLinkIcon), link: string, ariaLabel?: string }` | - |
### SocialLinkIcon
```ts
type SocialLinkIcon =
| 'dribbble'
| 'facebook'
| 'figma'
| 'github'
| 'instagram'
| 'jike'
| 'link'
| 'notion'
| 'npm'
| 'rednote'
| 'rss'
| 'threads'
| 'stackoverflow'
| 'weibo'
| 'x'
| 'youtube'
| { svg: string }
```
### Algolia Application
1. Deploy your site first
2. Apply for an `apiKey` at [algolia](https://docsearch.algolia.com/apply/)
3. After successful application, configure `algolia` in `slate.config.ts`
4. Redeploy
### Follow Subscription Authentication
1. Register a [follow](https://follow.is/) account
2. Deploy your site
3. Click the `+` button on `follow`, select `RSS` subscription, and enter the `rss` link (usually `[site]/rss.xml`, where `site` is the value of `site` in `slate.config.ts`)
4. Redeploy
## Article Frontmatter Description
| Option | Description | Type | Required |
| --- | --- | --- | --- |
| title | Article title | `string` | Yes |
| description | Article description | `string` | No |
| tags | Article tags | `string[]` | No |
| draft | Whether it's a draft. When not provided or `false`, `pubDate` must be provided; drafts are only visible in local preview | `boolean` | No |
| pubDate | Article publication date | `date` | No, required when `draft` is `false` |
**For more details, check the `src/content/config.ts` file**
### Example
```md
---
title: 40 questions
description: This repo maintains revisons and translations to the list of 40 questions I ask myself each year and each decade.
tags:
- Life
- Thinking
- Writing
pubDate: 2025-01-06
---
```
## Markdown Syntax Support
In addition to standard Markdown syntax, the following extended syntax is supported:
### Basic Syntax
- Headers, lists, blockquotes, code blocks and other basic syntax
- Tables
- Links and images
- **Bold**, *italic*, and ~strikethrough~ text
### Extended Syntax
#### Container syntax
Using `:::` markers
```md
:::info
This is an information prompt
:::
```
#### LaTeX Mathematical Formulas
- Inline formula: $E = mc^2$
- Block formula: $$ E = mc^2 $$
#### Support for image captions
```md
```
## Updates
### Version 1.1.1
- Fixed known issues
### Version 1.1
- Upgraded to support [Tailwind CSS v4.0](https://tailwindcss.com/blog/tailwindcss-v4)
- Added dark mode support
- Fixed known issues