https://github.com/gearfox98/static
A static web site generator inspired by React and written in Python 🐍
https://github.com/gearfox98/static
framework html python3 static-site-generator web-development
Last synced: 12 months ago
JSON representation
A static web site generator inspired by React and written in Python 🐍
- Host: GitHub
- URL: https://github.com/gearfox98/static
- Owner: GearFox98
- License: mit
- Created: 2025-02-11T04:46:15.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-03-17T01:46:39.000Z (about 1 year ago)
- Last Synced: 2025-03-17T02:41:51.373Z (about 1 year ago)
- Topics: framework, html, python3, static-site-generator, web-development
- Language: Python
- Homepage:
- Size: 275 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Static ⚡
A static web site generator inspired by React and written in Python 🐍
Static gives complete flexibility for building the site as it just focus on sew the pieces together. All you require is basic web programing skills and a bit of Python!
### Instalation
Clone this repository and uncompress the program. Copy the 'skel' folder where you want to work and give 'static' execution permissions.
#### Debian
If you have a Debian-like distro installed, you can install the _DEB_ package, available [here](https://github.com/GearFox98/static/releases).
```bash
sudo dpkg -i static_1.0-x_all.deb
```
#### Arch (AUR)
If you have Arch installed, you can install the `static` from _AUR_
```bash
git clone https://aur.archlinux.org/static-git.git
cd static-git
pkgbuild -i
```
### Usage
#### Starting a new project
```bash
static-init [options]
```
> #### **Options available:**
> **-b, --bootstrap**: gets a Bootstrap dist and installs it in the `data` folder in the project. Useful to code in places with unstable network
_Note_: If no `path` provided Static⚡ will assume `current directory` to initialize the project.
#### Running the project
```bash
static [command]
```
> #### **Commands available:**
> **check**: checks the directory structure looking for missing directories. If there are some folders missing, this command will create them. The program stops if `html` or `pages` folders are not in the directory.
> **build**: implies `check`, if there's no errors found, the program will generate the pages' content in a temporary folder and tailor the pieces in one file for each page in the `dist` folder.
> **run** - Serves `dist` folder of the project, if the site is not built it calls `build` command.
> #### **Options available:**
> **-i, --interactive** - Sets interactive mode. Manual mode. Use with `run`