Skip to main content

Engrave is a static website framework

Project description

Engrave is a tool to generate static website.

Features

  • Write contents in HTML and Markdown.
  • Style sheet (CSS) with SASS
  • HTML template with Jinja

Requirement

NodeJS v14.16 or later

Installation

$ pip install engrave

Usage

$ engrave -h
usage: engrave [-h] {setup,build,dev} ...

Static website generator

positional arguments:
  {setup,build,dev}
    setup            Install required libraries from npm: parcel, sass
    build            Build html
    dev              Build html and watch for changes

Example

This document is made by Engrave and it's a good example how engrave works. See document's source code at

To build this document and run development server, use command below

$ git clone https://github.com/nitipit/engrave.git
$ cd engrave
$ npm install # Install Node Libraries
$ engrave dev docs-src docs --server

Copyright 2021 Nitipit Nontasuwan (MIT License)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

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

engrave-1.1.0.tar.gz (4.5 kB view hashes)

Uploaded Source

Built Distribution

engrave-1.1.0-py3-none-any.whl (5.6 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