https://github.com/fernandocelmer/mkdocs-simple-blog

Blog Template for Mkdocs
https://github.com/fernandocelmer/mkdocs-simple-blog

blog markdown md mkdocs mkdocs-theme pypi pypi-package python

Last synced: 13 days ago
JSON representation

Blog Template for Mkdocs

• Host: GitHub
• URL: https://github.com/fernandocelmer/mkdocs-simple-blog
• Owner: FernandoCelmer
• License: mit
• Created: 2023-01-13T15:02:34.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2024-10-27T20:39:00.000Z (17 days ago)
• Last Synced: 2024-10-27T23:45:07.632Z (17 days ago)
• Topics: blog, markdown, md, mkdocs, mkdocs-theme, pypi, pypi-package, python
• Language: CSS
• Homepage: https://fernandocelmer.github.io/mkdocs-simple-blog/
• Size: 1.38 MB
• Stars: 78
• Watchers: 2
• Forks: 5
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# [MkDocs Simple Blog](https://fernandocelmer.github.io/mkdocs-simple-blog/)

>  Theme for [MkDocs](https://www.mkdocs.org/)

![Image](https://raw.githubusercontent.com/FernandoCelmer/mkdocs-simple-blog/develop/docs/assets/simple-blog.png)

![GitHub forks](https://img.shields.io/github/forks/FernandoCelmer/mkdocs-simple-blog?label=Forks&style=flat-square)

![GitHub Repo stars](https://img.shields.io/github/stars/FernandoCelmer/mkdocs-simple-blog?label=Stars&style=flat-square)

![GitHub last commit](https://img.shields.io/github/last-commit/FernandoCelmer/mkdocs-simple-blog?style=flat-square)

![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/FernandoCelmer/mkdocs-simple-blog/python-publish-pypi.yml?label=%F0%9F%93%A6%20PyPI&style=flat-square)

![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/FernandoCelmer/mkdocs-simple-blog/python-publish-pypi-test.yml?label=%F0%9F%93%A6%20PyPI-Test&style=flat-square)

## Install

### Installation MkDocs

To install MkDocs, run the following command from the command line:

```bash

pip install mkdocs

```

### Installation theme

Install the theme using PIP:

```bash

pip install mkdocs-simple-blog

```

### Activating theme

After the theme is installed, edit your `mkdocs.yml` file and set the theme name to `simple-blog`:

```yml

theme:

    name: simple-blog

```

## Getting Help

We use GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them. If you need anything, I ask you to please follow our templates for opening issues or discussions.

- 🐛 [Bug Report](https://github.com/FernandoCelmer/mkdocs-simple-blog/issues/new)

- 📕 [Documentation Issue](https://github.com/FernandoCelmer/mkdocs-simple-blog/issues/new)

- 🚀 [Feature Request](https://github.com/FernandoCelmer/mkdocs-simple-blog/issues/new)

- 💬 [General Question](https://github.com/FernandoCelmer/mkdocs-simple-blog/issues/new)

## Commit Style

- ⚙️ FEATURE

- 📝 PEP8

- 📌 ISSUE

- 🪲 BUG

- 📘 DOCS

- 📦 PyPI

- ❤️️ TEST

- ⬆️ CI/CD

- ⚠️ SECURITY

## License

![GitHub](https://img.shields.io/github/license/FernandoCelmer/mkdocs-simple-blog?style=flat-square)

This project is licensed under the terms of the MIT license.