diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..0ab1e12 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,9 @@ +root = true + +[*.{md,py,txt}] +indent_style = space +indent_size = 4 +end_of_line = lf +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true diff --git a/.gitignore b/.gitignore index b6e4761..38a24a9 100644 --- a/.gitignore +++ b/.gitignore @@ -2,7 +2,7 @@ __pycache__/ *.py[cod] *$py.class - +.idea/ # C extensions *.so @@ -10,7 +10,7 @@ __pycache__/ .Python build/ develop-eggs/ -dist/ +/dist/ downloads/ eggs/ .eggs/ diff --git a/CHANGELOGS.md b/CHANGELOGS.md new file mode 100644 index 0000000..c64e7f4 --- /dev/null +++ b/CHANGELOGS.md @@ -0,0 +1,36 @@ +# CHANGELOGS + +## 1.1.0 + +* Bulk refactors and code documentation +* New commands for `static.py` files + * `--serve` for livewatch changes + * `--watch` for watch specific files and folders. + * `--port` especiffy serve port + +## 1.0.0 + +* Back to namespace method for write templates names + * Example: `html5up/massively` instead of just `massively` +* Template assets are not included in the library to minimize the size of the library, they were moved to + a [separate repository](https://github.com/jamstackpy/jamstack-templates). + +## 0.1.0 + +* Improve **Plain** template +* Add new templates (massively, phantom) +* When creating a project, instead of writing the template like this: **html5up/massively**, you can use the name + directly, i.e. **massively** +* The assets of each template are now included in the library + +## 0.0.4 + +* Add README.md info + +## 0.0.3 + +* Add plain template + +## 0.0.1 + +* Initial release diff --git a/README.md b/README.md index e38b842..8d4ee1d 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,75 @@ -# jamstack +
+ Jamstack logo +
![](https://img.shields.io/pypi/v/jamstack) -Install +Also known as Jamstackpy, is a tool that allows you to create static websites using the power of **Python** hand in hand +with the [Flask](https://github.com/pallets/flask) library. Its operation is based on templates which are rendered with +the powerful Jinja engine generating your website with all its dependencies. + +## Installation ```bash python -m pip install jamstack ``` -Create basic project +## Create basic project ```bash jamstack plain ``` -`jamstack plain myproject` +## Templates + +Jamstack has templates available courtesy of [html5up](https://html5up.net). + +| Template | Command | Tutorial | +|--------------------------------------------|-------------------|--------------------------------------------------------------------------| +| [Massively](https://html5up.net/massively) | html5up/massively | | +| [Phantom](https://html5up.net/phantom) | html5up/phantom | [**HERE**](https://github.com/jamstackpy/jamstack/wiki/Phantom-template) | +The syntax is as follows: + +```bash +jamstack t +``` -with available templates +Use the `--existing` flag if you want the project to be created in an existing folder ```bash -jamstack t