Package: cpfr-rattlesnake
Rattlesnake Static Site GeneratorRattlesnake is a static website generator.
It is written in the Python programming language and utilizes the Jinja templating engine, pySCSS for SCSS support, as well as the pyYaml library for parsing config files.Seehttps://pac4.gitlab.io/rattlesnake/for more information.UsageRattlesnake needs the following things:Aconfig.ymlfile that contains configuration properties and variables for the site renderingAsrcfolder that contains the source files for the website.It generates abuilddirectory that will contain the ready-to-deploy website after running the build script.The build follows the convention that files starting with an underscore (e.g._header.html) are not built as pages, but used as template files viaJinja. All HTML files not starting with an underscore will be converted into pages. Files with the nameindex.htmlwill keep their relative path. However, all other HTML files will be moved into a directory with the same name as the original file (without extension) and stored as anindex.htmlinside that folder. This means that a file./src/about.htmlwill be processed into a file./build/about/index.html. This is due to the way the browser and the web server handle paths. This creates nicer looking URLs (https://youwebsite.org/aboutinstead ofhttps://youwebsite.org/about.html).Command-Line Interfaceusage: rattlesnake [-h] [-w] [-o OUTPUT_DIR] [-p PORT] [-c CONFIG_FILE] [-a ADDITIONAL_CONFIG] [source_dir]

This tool converts your markdown text and HTML into a static website.

positional arguments:
  source_dir

options:
  -h, --help            show this help message and exit
  -w, --watch
  -o OUTPUT_DIR, --output-dir OUTPUT_DIR
  -p PORT, --port PORT
  -c CONFIG_FILE, --config-file CONFIG_FILE
  -a ADDITIONAL_CONFIG, --additional-config ADDITIONAL_CONFIGBy default,./srcis used as the input directory. This can be changed by specifying a different path as the first argument.By default,./buildis used as the output directory. This can be changed by specifying a different path using the--output-diroption.By default,./config.ymlis used as the config file for parameters and template variables. This can be changed by specifying a different file path using the--config-fileoption.The--watchoption keeps the script running after the build process and watches the source directory for file changes. Further, it starts an HTTP server that serves the built website.The--portoption allows the user to specify a port if the --watch flag is given. If no custom port is provided, port8000is used.The--additional-configoption can be used in order to load an additional config yaml file that supplement or overrides the default values. This can be useful for different deployment targets.Version History1.0.4: adding fenced code blocks to markdown parsing1.0.3: introducing meta-variables for page paths_target_pathpoints to the path of the page relative to the website's base url_source_pathpoints to the path of the source file relative to the input directory1.0.2: Bugfixesdirectories starting with an underscore are also skipped (not just files)adding date formatting filter to Jinja parser ({{ some_date | format_date("%d.%m.%Y") }})1.0.0: Initial Implementation