Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/krake747/krake-blog

Krake Blog
https://github.com/krake747/krake-blog

Last synced: 3 days ago
JSON representation

Krake Blog

Awesome Lists containing this project

README

        

# krake-blog

I was generally curious about static site generators. I thought why not give it a go and create a simple blog.
I am using Material for MkDocs instead of creating my own site, because of its many features and community support.
In addition, Material for MkDocs is easy to setup and deploy to GitHub Pages.

Now whether I will actually produce blog content remains to be seen.

You can visit the blog on [krake-blog](https://krake747.github.io/krake-blog/)

## Quick start

```bash
py -m venv .venv
pip install mkdocs-material
or
pip install -r requirements.txt
```

Note: Run `source .venv/bin/activate` to activate the vritaul environment on Linux.

## How to upgrade

```bash
pip install --upgrade --force-reinstall mkdocs-material
pip show mkdocs-material
```

For full documentation visit

[![Built with Material for MkDocs](https://img.shields.io/badge/Material_for_MkDocs-526CFE?style=for-the-badge&logo=MaterialForMkDocs&logoColor=white)](https://squidfunk.github.io/mkdocs-material/)

and [MkDocs](https://www.mkdocs.org).

## Commands

- `mkdocs new [dir-name]` - Create a new project.
- `mkdocs serve` - Start the live-reloading docs server.
- `mkdocs build` - Build the documentation site.
- `mkdocs -h` - Print help message and exit.