mirror of
https://github.com/venthur/blag.git
synced 2025-11-25 12:42:41 +00:00
updated readme
This commit is contained in:
18
README.md
18
README.md
@@ -1,11 +1,13 @@
|
||||
# blag
|
||||
|
||||
blag is a blog-aware, static site generator, written in Python.
|
||||
blag is a blog-aware, static site generator, written in [Python][].
|
||||
|
||||
blag is named after [the blag of the webcomic xkcd][blagxkcd].
|
||||
|
||||
[python]: https://python.org
|
||||
[blagxkcd]: https://blog.xkcd.com
|
||||
|
||||
|
||||
## Features
|
||||
|
||||
* Write content in [Markdown][]
|
||||
@@ -13,16 +15,18 @@ blag is named after [the blag of the webcomic xkcd][blagxkcd].
|
||||
* Generation of Atom feeds for blog content
|
||||
* Fenced code blocks and syntax highlighting using [Pygments][]
|
||||
|
||||
blag runs on Linux, Mac and Windows and requires Python >= 3.8
|
||||
|
||||
[markdown]: https://daringfireball.net/projects/markdown/
|
||||
[jinja2]: https://palletsprojects.com/p/jinja/
|
||||
[pygments]: https://pygments.org/
|
||||
|
||||
## Installation
|
||||
|
||||
## Quickstart
|
||||
|
||||
```bash
|
||||
$ pip install blag
|
||||
$ pip install blag # 1. install blag
|
||||
$ blag quickstart # 2. create a new site
|
||||
$ vim content/hello-world.md # 3. create some content
|
||||
$ blag build # 4. build the website
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
TBD
|
||||
|
||||
2
setup.py
2
setup.py
@@ -10,7 +10,7 @@ meta['long_description'] = open('./README.md').read()
|
||||
setup(
|
||||
name='blag',
|
||||
version=meta['__VERSION__'],
|
||||
description='simple blog-aware static site generator',
|
||||
description='blog-aware, static site generator',
|
||||
long_description=meta['long_description'],
|
||||
long_description_content_type='text/markdown',
|
||||
keywords='markdown blag blog static site generator cli',
|
||||
|
||||
Reference in New Issue
Block a user