SharpBlog is VitePress' theme, built on top of VitePress.
Hey all 👋 !!
SharpBlog is VitePress' theme, built on top of VitePress.
this the is build on vitePress alpha stage. It is already suitable for out-of-the-box documentation use, but the config and theming API may still change between minor releases.
$ yarn install$ yarn build$ yarn devblog
├─ .vitepress
│ ├─ theme
│ └─ config.js
├─ pages
│ └─ about.md
├─ posts
│ ├─ first-post.md
│ ├─ second-post.md
│ └─ ...
├─ server
│ └─ server.js
│ └─ index.md
└─ package.json
- All posts goes in the posts folder.
- Posts will be fetched and parsed automaticlly in the server.js file
- The theme follow the basic VitePress project structure with a .vitepress folder that contain the theme and blog config.js file
for mere information please check the official documentation
All blog's posts are under the Blog/posts folder. We are using fronmatter format to collect some metadata and have the needed visual
A post can have:
- a title
- a date
- an author
- a category with custom color
- a cover
- a description
Warning date,author and discription are hidden from the UI of not present in the article metadata cover image will display a random image if not present
Example of a markdown header for an post
---
layout: doc
date: 2022-08-30
title: Host your first blog with VitePress
author: Jon Doe
category: News
categoryColor: "#1abc9c" // default to gray
cover: /assets/cover.jpg
description: Dummy is a content generation toolkit designed to make the development, testing and presentation of web prototypes less time consuming and more realistic.
---
# you content here
....Warning If you are using a local asset as cover image. the image needs to go under the
publicfolder. Note that you should reference files placed in public using root absolute path - for example,public/icon.pngshould always be referenced in source code as/icon.png. for more details please check the official documentation for asset handling
Please refert to VitePress official documentation for deployment and configuration
Please make sure to read the Contributing Guide before making a pull request.