Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dumptyd/content-theme-blog-minimal
content-theme-blog-minimal is a standalone theme for creating your blog within minutes!
https://github.com/dumptyd/content-theme-blog-minimal
blog blog-theme nuxt nuxt-content theme vue
Last synced: 3 months ago
JSON representation
content-theme-blog-minimal is a standalone theme for creating your blog within minutes!
- Host: GitHub
- URL: https://github.com/dumptyd/content-theme-blog-minimal
- Owner: dumptyd
- License: mit
- Created: 2021-11-08T04:06:11.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2021-12-31T05:17:29.000Z (about 3 years ago)
- Last Synced: 2024-10-11T08:50:54.446Z (3 months ago)
- Topics: blog, blog-theme, nuxt, nuxt-content, theme, vue
- Language: Vue
- Homepage: https://dumptyd.github.io/content-theme-blog-minimal
- Size: 1.82 MB
- Stars: 16
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# content-theme-blog-minimal
`content-theme-blog-minimal` is a standalone theme for creating your blog within minutes!
**Demo:** https://dumptyd.github.io/content-theme-blog-minimal
## Feature Overview
- Write your content in markdown with full access to TailwindCSS utilities for styling.
- Categories & tags
- Syntax highlighting with 30+ themes to chose from
- Light and dark mode
- Sitemap
- Cloudflare analytics support
- Gallery component for rendering image grids in markdown
- Out of the box continuous deployment for GitHub pages
## Usage
### Setup
1. Clone this repository.
2. Run `yarn install`.
1. Don't have `node` installed?
2. [Install `nvm`](https://davidwalsh.name/nvm).
3. Install node using `nvm`. (The theme was created and tested on node 12.)
4. `npm install -g yarn`
5. Now you should be all set to run `yarn install`.
### Writing and customization
1. Modify the default config in [`blog.config.js`](blog.config.js).
2. Run `yarn dev` to start the development server.
3. Start writing by adding markdown files in [/content/posts](content/posts) and update [/content/about.md](content/about.md).
For more configuration options, check out [Markdown and theme configuration](#markdown-and-theme-configuration).
### Deploy
1. Make sure there are no errors by running `yarn lint`. Run `yarn lint --fix` to fix the auto-fixable ones.
2. Make sure `productionPublicPath` in `blog.config.js` is set correctly.
2. If you're deploying to GitHub pages, push your changes to `master` and that's it.
3. For deploying to other services, modify the `Deploy` step in [deploy.yml](.github/workflows/deploy.yml) and then push to master.
### Getting new features
```sh
git remote add upstream https://github.com/dumptyd/content-theme-blog-minimal.git
git fetch upstream master
git checkout master
git rebase upstream/master
```
---
### Markdown and theme configuration
#### blog.config.js
All the high level customizations should be done using this file. Documentation for individual attributes is provided in [`blog.config.js`](blog.config.js).
#### Frontmatter
Frontmatter block should be added at the very top of the markdown files.
**All fields are optional.** If none of the posts have `category` or `tags` set then those links will be hidden from the navbar respectively.
| Attribute | Type | Description |
| - | - | - |
| `title` | string | Title of the post. Defaults to the path. |
| `description` | string | Description for the post. This is used on listing page and for meta:description. |
| `createdAt` | string | Post creation datetime. Defaults to the datetime when the file was created. |
| `category` | string | Category under which the post should be grouped into. |
| `tags` | array | Tags for the post. |
**Example**
```md
---
title: "First post"
createdAt: "2018-12-31"
category: "Web Development"
tags: ["javascript", "vue", "html"]
---
```
#### Images and other static content
Images should be put under `static/images`. They can then be linked using this syntax `` or `img` tags.
Other static content can be put under `static/` as well. Each file inside this directory is mapped to `/`.
#### Custom components
The theme comes with these custom components that can be used inside markdown files just like HTML tags.
**`social`** - By default, this is shown on the footer when social links are present. Use `` to add that section in other places like about.md.
**`gallery` and `gallery-item`** - A basic set of components for showcasing images. Check out [showcasing-images.md](showcasing-images) to see them in action.
### Might add in the future
- [ ] Code copy widget
- [ ] Full text search
- [ ] Additional options in navbar
- [ ] Draft state
- [ ] Table of contents
- [ ] Opt-in GitHub flavored markdown styles