https://github.com/zztkm/py-ghpages
ghpages is a CLI tool for easily publishing static content to GitHub Pages.
https://github.com/zztkm/py-ghpages
cli gh-pages python
Last synced: over 1 year ago
JSON representation
ghpages is a CLI tool for easily publishing static content to GitHub Pages.
- Host: GitHub
- URL: https://github.com/zztkm/py-ghpages
- Owner: zztkm
- License: mit
- Created: 2022-06-23T04:02:22.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-06-03T02:01:30.000Z (about 3 years ago)
- Last Synced: 2024-04-23T13:08:34.925Z (about 2 years ago)
- Topics: cli, gh-pages, python
- Language: Python
- Homepage: https://pypi.org/project/ghpages/
- Size: 28.3 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ghpages
ghpages is a CLI tool for easily publishing static content to GitHub Pages.
For example, it is useful to publish API documentation generated by [Sphinx](https://www.sphinx-doc.org/en/master/)
## Install
via: pipx (Recommended)
```
pipx install ghpages
```
via: pip
```
pip install ghpages
```
via: [rye](https://rye-up.com/) (Recommended)
```
rye install ghpages
```
## Usage
Publish the contents of the `dist` directory
```shell
ghpages dist
```
Congratulations! If you see a success message, you are ready to publish on GitHub Pages!
## Development
setup
```console
poetry install
```
activate
```console
poetry shell
```
setup pre-commit
```console
poetry run pre-commit install
```
run tox
```console
poetry run tox
```