ttpages/README.md

45 lines
893 B
Markdown
Raw Normal View History

2024-08-14 12:16:13 -04:00
# TTPages action workflow
This repository contains the source code of the TTPages workflow for TTGit Actions.
## Usage of the workflow
> Notice:
>
> Make sure you have actions enabled on your account and repository!
Usage example:
```yaml
steps:
- name: Publish to TTPages
uses https://git.ttnrtsite.me/actions/ttpages
with:
path: <folder of static files>
```
The workflow would then look like this:
```yaml
---
name: Publish site
on:
push:
branches: [main] # Change this if your branch is different
jobs:
publish:
runs-on: ubuntu-latest
steps:
- name: Checkout Code
uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Publish site
uses: https://git.ttnrtsite.me/actions/ttpages
with:
path: output_folder
```
If you use a static site generator, you may add other steps to publish your website data.