ClariSys/python-webgen
ClariSys/python-webgen
0
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
ClariSys 2025-04-07 23:32:28 -07:00
parent e39a0b85e7
commit 16278b0921
1 changed files with 28 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

44
README.md
View file

@ -1,26 +1,38 @@
# python-webgen # python-webgen
a set of python scripts and html templates to generate blog-style websites A set of python scripts and html templates to generate blog-style websites.
# Usage
--- For built in help, use the `--help` option.
## Getting Started
Welcome to your new KitsuDev Repo, ChloeCat! Feel free to make this place your own! ## General Usage:
## Make your first push! ### Basic usage:
Once you're ready to push your files, use these commands to get to your spot! `python webgen.py <input folder> <output folder>`
```bash This will use the default location for the template files (`./templates/`) and the css file (`./templates/stylesheet.css`).
git remote add origin https://kitsunes.dev/ChloeCat/python-webgen.git This will also set the title to simply "Blog", use `--site_title` to change that.
git branch -M main
git push -uf origin main
```
Once you're all set, please [Make a README](https://www.makeareadme.com/)! ### Example use:
`python webgen.py --site_title "Chloe's Blog" --title_all --css_file ~/css/custom_v2.css ~/Blog/posts/ ~/Blog/output/`
--- This will generate a site with a title of "Chloe's Blog," which will be applied to the HTML title of all the articles, in addition to the article title.
Have fun, and happy coding! It will also use a custom CSS file from `~/css/custom_v2.css` which is different from the default.
The posts will come from a folder in the `~/Blog/posts/` folder and the completed HTML files will be placed in `~/Blog/output/`.
-- Kio ## Availible Arguments:
(p.s. and while you're at it, say hi to pearl.) | Argument | Description |
|-----------------|-----------------------------------------------------------------------------------------------------------------------|
|`input_path` |The folder to read the markdown files from. |
|`output_path` |The folder to place the final HTML files in. |
|`--template_path`|The folder where the template HTML snippets are. Default: `./templates/` |
|`--css_file` |The location of a css file to copy to the output folder defined in `output_path`. Default: `./templates/stylesheet.css`|
|`--site_title` |The title shown on the main page. |
|`--title_all` |If enabled, add the main site title to the HTML Title field on the individual articles. |
|`-v` |More output. |
# TODO
- Add support for image folders
- Handle files correctly :3
- GUI interface?