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.1.tar.gz (18.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mksite-0.1.1-py3-none-any.whl (18.2 kB view details)

Uploaded Python 3

File details

Details for the file mksite-0.1.1.tar.gz.

File metadata

  • Download URL: mksite-0.1.1.tar.gz
  • Upload date:
  • Size: 18.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.27.0

File hashes

Hashes for mksite-0.1.1.tar.gz
Algorithm Hash digest
SHA256 a9d5492d5d31332dbc470de6c39002671a25d22940cd2358d2a3786fc72d168d
MD5 47834837a04ad6f2fb0c43963cc031c3
BLAKE2b-256 35f482af3ae7fb390915830054ee845e0bb40a6e1c179f7ab6a6c05df2ab0a16

See more details on using hashes here.

File details

Details for the file mksite-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: mksite-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 18.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.27.0

File hashes

Hashes for mksite-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7a89c46c27485db7c82516f1bdd3363b068cfc24ee6069fc6c4b592715eace6f
MD5 b92657d308807852f21f1f9e9c8130b5
BLAKE2b-256 d283a98d999175f2b5a8b7e35e1b96068b901050aa53e22ff40453150be80d9e

See more details on using hashes here.

Supported by

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