PlainPage
1.0.0
A fast, text-focused, minimalist blog.
English | 中文
├── public/
├── src/
│ ├── components/
│ ├── content/
│ ├── layouts/
│ ├── pages/
│ └── consts.ts
├── astro.config.mjs
├── README.md
├── package.json
└── tsconfig.json
The src/content/
directory contains "collections" of related Markdown and MDX documents. Use getCollection()
to retrieve posts from src/content/blog/
, and type-check your frontmatter using an optional schema. See Astro's Content Collections docs to learn more.
Any static assets, like images, can be placed in the public/
directory.
All configuration is in src/consts.ts
.
// src/consts.ts
// site config
export const SITE_TITLE = "PlainPage";
export const SITE_DESCRIPTION = "Welcome (. ❛ ᴗ ❛.)";
export const COPYRIGHT = "© 2024 PlainPage All Rights Reserved";
export const ICP_NUMBER = "";
// social links, empty or commented out = not displayed
export const SOCIAL_LINKS = {
Github: "https://github.com/churchTao",
Twitter: "https://twitter.com/yourusername",
// LinkedIn: "https://www.linkedin.com/in/yourusername",
// Instagram: "https://www.instagram.com/yourusername",
// Facebook: "https://www.facebook.com/yourusername",
// YouTube: "https://www.youtube.com/yourusername",
};
// SEO related
export const SEO_CONFIG = {
ogImage: "/hero-img.png", // default social media share image
keywords: "blog, tech, programming", // default keywords
};
// navigation config
export const NAV_ITEMS = [
{ text: "Home", link: "/" },
{ text: "Blog", link: "/blog" },
{ text: "Tags", link: "/tags" },
{ text: "About", link: "/about" },
];
// blog config
export const BLOG_CONFIG = {
locale: "en-us", // date format language
authorName: "Author Name", // author name
email: "mailto:[email protected]",
tags: {
title: "Tags", // tags page title
description: "All the tags used in posts.", // tags page description
},
};
All commands are run from the root of the project, from a terminal:
Command | Action |
---|---|
npm install |
Installs dependencies |
npm run dev |
Starts local dev server at localhost:4321 |
npm run build |
Build your production site to ./dist/ |
npm run preview |
Preview your build locally, before deploying |
npm run astro ... |
Run CLI commands like astro add , astro check |
npm run astro -- --help |
Get help using the Astro CLI |
This theme is based off of the lovely Bear Blog.
Inspired by satnaing/astro-paper.
Based on astro.
? You can submit your site to the list by creating a PR.
Licensed under the MIT License, Copyright © 2024