Highly customizable static site generator for reStructuredText markup https://nixhacks.net/rsw/
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
ge 2e240aa147 add README and docs 6 months ago
docs add README and docs 6 months ago
rsw fix package data search 6 months ago
.gitignore update .gitignore 6 months ago
COPYING add license 6 months ago
MANIFEST.in add build tools 6 months ago
Makefile update makefile 6 months ago
README add README and docs 6 months ago
pyproject.toml update pyproject 6 months ago
requirements.txt update dependencies 6 months ago
setup.py add build tools 6 months ago



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


* https://nixhacks.net/rsw/
* https://git.nxhs.cloud/ge/rSW/src/branch/master/docs


From PyPI


    pip install reSW

From tarball


    pip install ./reSW-0.1.2.tar.gz

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">
        <meta charset="utf-8">
        <title>{{ page.title }}</title>
       {{ html | safe }}

   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)

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

      -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.


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