Skip to main content

Static site generator that supports markdown and html.

Project description

mksite


builds.sr.ht status PyPI - Version License: AGPL v3

like mkdir but for websites

mksite helps you to quickly generate static websites with markdown.

Installation

pip install mksite

Quickstart

Create site directory structure and change into site directory:

mkdir -p site/content site/static
cd site

Add some site files:

echo "<h1>Hello, world!</h1>" > content/index.md
echo "h1 {color: darkblue;}" > static/style.css

Add config.toml inside site directory:

base = "https://mksite.com"
lang = "en-us"

[directories]
content = "content"
static = "static"

[nav]
[[nav.items]]
name = "home"
uri = "/"

Build static site using mksite CLI:

mksite build

Serve website using Python's http server:

python -m http.server -d public 8000

Navigate to port 8000.

License

mksite is distributed under the terms of the AGPLv3 license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mksite-0.1.0.tar.gz (18.1 kB view hashes)

Uploaded Source

Built Distribution

mksite-0.1.0-py3-none-any.whl (18.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page