mirror of
https://github.com/daylinmorgan/viv.git
synced 2024-12-22 02:30:44 -06:00
docs: add minimal docs to implement remote deployment
This commit is contained in:
parent
9aea8acc53
commit
034403b7a8
GPG key ID:
C1E52E7DD81DF79F
8 changed files with 38 additions and 105 deletions
29
.github/workflows/docs.yml
vendored
Normal file
29
.github/workflows/docs.yml
vendored
Normal file
|
|
@ -0,0 +1,29 @@
|
||||||
|
name: GitHub Pages
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
tags: ["v*.*.*"]
|
||||||
|
workflow_dispatch:
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
deploy-docs:
|
||||||
|
runs-on: ubuntu-22.04
|
||||||
|
permissions:
|
||||||
|
contents: write
|
||||||
|
concurrency:
|
||||||
|
group: ${{ github.workflow }}-${{ github.ref }}
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: Add Source to Docs
|
||||||
|
run: |
|
||||||
|
mkdir docs/viv -p
|
||||||
|
cp ./src/viv/viv.py docs/viv/viv.py
|
||||||
|
|
||||||
|
- name: Deploy
|
||||||
|
uses: peaceiris/actions-gh-pages@v3
|
||||||
|
if: ${{ github.ref == 'refs/heads/main' }}
|
||||||
|
with:
|
||||||
|
github_token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
# publish_dir: ./site
|
||||||
|
publish_dir: ./docs
|
||||||
BIN
docs/demo.gif
BIN
docs/demo.gif
Binary file not shown.
|
Before Width: | Height: | Size: 757 KiB |
11
docs/demo.py
11
docs/demo.py
|
|
@ -1,11 +0,0 @@
|
||||||
#!/usr/bin/env python3
|
|
||||||
|
|
||||||
__import__("viv").use("pyfiglet==0.8.post1") # noqa
|
|
||||||
|
|
||||||
from pyfiglet import Figlet
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
f = Figlet(font="slant")
|
|
||||||
figtxt = f.renderText("viv").splitlines()
|
|
||||||
figtxt[-2] += " isn't venv!"
|
|
||||||
print("\n".join(figtxt))
|
|
||||||
|
|
@ -1,23 +0,0 @@
|
||||||
Set Height 750
|
|
||||||
Set Width 1500
|
|
||||||
Set Theme "Catppuccin Mocha"
|
|
||||||
Output ./demo.gif
|
|
||||||
|
|
||||||
Type "viv list"
|
|
||||||
Enter
|
|
||||||
Sleep 2s
|
|
||||||
Type "python ../examples/cli.py --help"
|
|
||||||
Enter
|
|
||||||
Sleep 10s
|
|
||||||
Type "viv list"
|
|
||||||
Enter
|
|
||||||
Sleep 3s
|
|
||||||
Type "viv info 841"
|
|
||||||
Enter
|
|
||||||
Sleep 3s
|
|
||||||
Type "python ../examples/cli.py hello 'prospective viv user!'"
|
|
||||||
Enter
|
|
||||||
Sleep 2s
|
|
||||||
Type "python ../examples/cli.py goodbye 'prospective viv user!'"
|
|
||||||
Enter
|
|
||||||
Sleep 2s
|
|
||||||
|
|
@ -1,23 +0,0 @@
|
||||||
Set Height 750
|
|
||||||
Set Width 1500
|
|
||||||
Set Theme "Catppuccin Mocha"
|
|
||||||
Output ./freeze.gif
|
|
||||||
|
|
||||||
Type "viv freeze --help"
|
|
||||||
Enter
|
|
||||||
Sleep 2s
|
|
||||||
Type "viv list"
|
|
||||||
Enter
|
|
||||||
Sleep 2s
|
|
||||||
Type "viv freeze requests bs4"
|
|
||||||
Enter
|
|
||||||
Sleep 7s
|
|
||||||
Type "viv list"
|
|
||||||
Enter
|
|
||||||
Sleep 3s
|
|
||||||
Type "viv freeze requests bs4 --keep --path relative"
|
|
||||||
Enter
|
|
||||||
Sleep 7s
|
|
||||||
Type "viv list"
|
|
||||||
Enter
|
|
||||||
Sleep 5s
|
|
||||||
9
docs/index.html
Normal file
9
docs/index.html
Normal file
|
|
@ -0,0 +1,9 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="canonical" href="https://github.com/daylinmorgan/viv"/>
|
||||||
|
<meta name="robots" content="noindex">
|
||||||
|
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
|
||||||
|
<meta http-equiv="refresh" content="0; url=https://github.com/daylinmorgan/viv"/>
|
||||||
|
</head>
|
||||||
|
</html>
|
||||||
|
|
@ -1,30 +0,0 @@
|
||||||
Set Height 750
|
|
||||||
Set Width 1500
|
|
||||||
Set Theme "Catppuccin Mocha"
|
|
||||||
Output ./list-info-remove.gif
|
|
||||||
|
|
||||||
Type "cat demo.py"
|
|
||||||
Enter
|
|
||||||
Sleep 500ms
|
|
||||||
Type "python demo.py"
|
|
||||||
Enter
|
|
||||||
Sleep 3s
|
|
||||||
Type "viv list -h"
|
|
||||||
Enter
|
|
||||||
Sleep 500ms
|
|
||||||
Type "viv list -q"
|
|
||||||
Enter
|
|
||||||
Sleep 1s
|
|
||||||
Type "viv info -h"
|
|
||||||
Enter
|
|
||||||
Sleep 500ms
|
|
||||||
Type "viv info "
|
|
||||||
Sleep 1s
|
|
||||||
Type "f8"
|
|
||||||
Enter
|
|
||||||
Sleep 1s
|
|
||||||
Type "viv remove -h"
|
|
||||||
Enter
|
|
||||||
Type "viv rm f8"
|
|
||||||
Enter
|
|
||||||
Sleep 2s
|
|
||||||
|
|
@ -1,18 +0,0 @@
|
||||||
# Usage
|
|
||||||
|
|
||||||
*NOTE*: these demo gif's are a work in progress. If you'd like to see them you can run `vhs` locally with `make docs`.
|
|
||||||
|
|
||||||
<div align="center">
|
|
||||||
# Demo
|
|
||||||
|
|
||||||
<img src="https://raw.githubusercontent.com/daylinmorgan/viv/main/docs/demo.gif" alt="demo" width=600 >
|
|
||||||
|
|
||||||
# Freeze
|
|
||||||
|
|
||||||
<img src="https://raw.githubusercontent.com/daylinmorgan/viv/main/docs/freeze.gif" alt="demo" width=600 >
|
|
||||||
|
|
||||||
# List | Info | Remove
|
|
||||||
|
|
||||||
<img src="https://raw.githubusercontent.com/daylinmorgan/viv/main/docs/list-info-remove.gif" alt="demo" width=600 >
|
|
||||||
|
|
||||||
</div>
|
|
||||||
Loading…
Reference in a new issue