Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lxndrdagreat/phlex
Simple, flexible static HTML builder written in Python
https://github.com/lxndrdagreat/phlex
Last synced: 7 days ago
JSON representation
Simple, flexible static HTML builder written in Python
- Host: GitHub
- URL: https://github.com/lxndrdagreat/phlex
- Owner: lxndrdagreat
- License: mit
- Archived: true
- Created: 2017-03-17T13:47:49.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-04-10T00:44:57.000Z (over 6 years ago)
- Last Synced: 2024-09-07T02:21:34.325Z (about 1 month ago)
- Language: Python
- Homepage: https://phlex.io
- Size: 16.6 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-python-html - lxndrdagreat/phlex
- awesome-python-html - lxndrdagreat/phlex
README
# phlex
Simple, flexible static HTML builder written in Python.
# Features
- Cross platform.
- Extensible: custom parsers can be used to handle custom file formats.
- Python 3
- Can work with other workflows. For example, using it to process the HTML
as part of a [Gulp](https://gulpjs.com/) task.
# Requirements
- Python 3.x (Python 2.7 support coming soon)
- pyyaml (for default document parser)
- markdown (for default document parser)
- jinja2 (for default document parser)
# Installation
## from pypi
$ pip install phlex
## pip + github
### Latest Release
Use:
$ pip install git+https://github.com/lxndrdagreat/phlex.git
Required modules will be install automatically.
### Development
Use:
$ pip install git+https://github.com/lxndrdagreat/phlex.git@develop
Required modules will be install automatically.
# Usage
Running it is as simple as running the CLI tool from your project's directory:
$ ./phlex
# Configuration
## Source
`--source` can be used to set the directory (or file) for phlex to load.
Shortcut is `-s`. Defaults to `./src/pages`.
Example:
$ ./phlex --source path/to/pages
## Templates
You can set the path to the templates directory with `--templates` or `-t`.
Default is `./src/templates`.
Example:
$ ./phlex --templates path/to/templates
## Output Directory
By default, phlex outputs to the `./dist` folder. Use `--output` or `-o`
to change the output path.
Example:
$ ./phlex --output path/to/output/directory
## Config File
Instead of supplying all of the different settings via the commandline, you can instead
point the program to a JSON configuration file with `--config`. `-c` can also be used
as a shortcut.
Example:
$ ./phlex --config path/to/file.json
Example config file:
```json
{
"source": "path/to/source/files",
"output": "path/to/output/directory"
}
```