Skip to main content

Highly customizable static site generator for reStructuredText markup

Project description

reStructuredWeb (rSW, reSW or rstW) – is a highly customizable static site generator for the reStructuredText markup language.

Docs:

Installation

Via pip

pip install reSW

From tarball

pip install ./reSW-0.1.2.tar.gz

Install shell completion

pip install infi.docopt-completion
docopt-completion rsw

Quick start

  1. Initialise site with following commands:

    rsw init my_site
    cd my_site
  2. Create first template and post.

    Template layouts/template.jinja2:

    <!DOCTYPE html>
    <html lang="en">
      <head>
        <meta charset="utf-8">
        <title>{{ page.title }}</title>
      </head>
    <body>
       {{ html | safe }}
    </body>
    </html>

    Post content/index.rst:

    :title: Hello, World!
    :date: 1970-01-01
    
    =============
    Hello, World!
    =============
    
    Hello, there! This is my first site built with *re*\ **Structured**\ *Web*!
  3. Build your site:

    rsw build

Command Line Interface

Usage: rsw init [--no-makefile] [<name>]
       rsw build [-c <file>]
       rsw print [-c <file>] [--default] [--json]
       rsw (-h | --help | -v | --version)

Commands:
  init          initialise new site.
  build         build site.
  print         print configuration.

Options:
  -c <file>, --config <file>    configuaration file.
  -j, --json                    JSON output.
  -d, --default                 print default config.
  -M, --no-makefile             do not create Makefile.
  -h, --help                    print this help message and exit.
  -v, --version                 print version and exit.

Development

Build Python package

Variant 1:

pip install setuptools wheel twine
python setup.py sdist bdist_wheel

Variant 2:

pip install -U build
python -m build

Via Makefile (build package needed):

make build

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

reSW-0.1.2.tar.gz (7.2 kB view details)

Uploaded Source

Built Distribution

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

reSW-0.1.2-py3-none-any.whl (7.7 kB view details)

Uploaded Python 3

File details

Details for the file reSW-0.1.2.tar.gz.

File metadata

  • Download URL: reSW-0.1.2.tar.gz
  • Upload date:
  • Size: 7.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.7

File hashes

Hashes for reSW-0.1.2.tar.gz
Algorithm Hash digest
SHA256 fcbce755faac68202668acd9405a165839971e206cb718d73d5f415195454aab
MD5 0b80c7596af986c3fbf455f2dc10e0b5
BLAKE2b-256 f0943ccbe7e50dcf76b9e533360d914a6c896485a334b08c5fe9043d6edf5bf7

See more details on using hashes here.

File details

Details for the file reSW-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: reSW-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 7.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.7

File hashes

Hashes for reSW-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a87711cd13a6b8d8957fbaa4988ee034ff5b3f5743a299e7b246413e3ea01733
MD5 8b82f31bdad6825d200a3f43b539d042
BLAKE2b-256 9020dd139d43e22358747bb1fd541eb6cf80fb2e246deb20072c15da377e41b3

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