Skip to content

Commit

Permalink
Add boilerplate
Browse files Browse the repository at this point in the history
  • Loading branch information
ximion committed Aug 1, 2024
1 parent c901f38 commit 1375d0b
Show file tree
Hide file tree
Showing 12 changed files with 257 additions and 0 deletions.
76 changes: 76 additions & 0 deletions .github/workflows/pages.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Sample workflow for building and deploying a Hugo site to GitHub Pages
name: Deploy Hugo site to Pages

on:
# Runs on pushes targeting the default branch
push:
branches: ["main"]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

# Default to bash
defaults:
run:
shell: bash

jobs:
# Build job
build:
runs-on: ubuntu-latest
env:
HUGO_VERSION: 0.130.0
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0 # fetch all history for .GitInfo and .Lastmod
submodules: recursive
- name: Setup Go
uses: actions/setup-go@v5
with:
go-version: '1.22'
- name: Setup Pages
id: pages
uses: actions/configure-pages@v4
- name: Setup Hugo
run: |
wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb \
&& sudo dpkg -i ${{ runner.temp }}/hugo.deb
- name: Build with Hugo
env:
# For maximum backward compatibility with Hugo modules
HUGO_ENVIRONMENT: production
HUGO_ENV: production
run: |
hugo \
--gc --minify \
--baseURL "${{ steps.pages.outputs.base_url }}/"
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./public

# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Hugo output
public/
resources/
.hugo_build.lock
13 changes: 13 additions & 0 deletions content/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: Syntalos
toc: false
---

This is the landing page.

## Explore

{{< cards >}}
{{< card link="docs" title="Docs" icon="book-open" >}}
{{< card link="about" title="About" icon="user" >}}
{{< /cards >}}
6 changes: 6 additions & 0 deletions content/about.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: About
type: about
---

This is the about page.
18 changes: 18 additions & 0 deletions content/docs/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: Documentation
next: first-page
---

This is a demo of the theme's documentation layout.

## Hello, World!

```go {filename="main.go"}
package main

import "fmt"

func main() {
fmt.Println("Hello, World!")
}
```
9 changes: 9 additions & 0 deletions content/docs/first-page.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: Demo Page
type: docs
prev: /
next: docs/folder/
---

A simple demo page.

10 changes: 10 additions & 0 deletions content/docs/folder/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Folder
type: docs
prev: docs/first-page
next: docs/folder/leaf
sidebar:
open: true
---

Pages can be organized into folders.
54 changes: 54 additions & 0 deletions content/docs/folder/camera-tis.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
title: Leaf 22
---

TIS Camera
##########

The "TIS Camera" module supports industrial cameras from `The Imaging Source <https://www.theimagingsource.com/>`_.

Usage
=====

You need to install the `Linux driver/support package <https://www.theimagingsource.com/support/download/>`_
first in order to use the Syntalos camera module.
More advanced users can also build & install the Imaging Source SDK from its `source code (GitHub) <https://github.com/TheImagingSource/tiscamera>`_.

Afterwards, you can select a camera via its V4L2 or Aravis drivers and configure it in Syntalos.
Syntalos should support the full range of configuration options for each camera (with exception of partial sensor readout on some devices).

To vide the generated video, use a *Canvas* module.


Ports
=====

.. list-table::
:widths: 14 10 22 54
:header-rows: 1

* - Name
- Direction
- Data Type
- Description

* - Video🠺
- Out
- ``Frame``
- ~


Stream Metadata
===============

.. list-table::
:widths: 15 85
:header-rows: 1

* - Name
- Metadata

* - Video🠺
- | ``size``: 2D Size, Dimension of generated frames
| ``framerate``: Double, Target framerate per second.
| ``has_color``: Boolean, Whether the output frames have color or are grayscale.
7 changes: 7 additions & 0 deletions content/docs/folder/leaf.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Leaf Page
type: docs
prev: docs/folder/
---

This page is under a folder.
5 changes: 5 additions & 0 deletions go.mod
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
module github.com/imfing/hextra-starter-template

go 1.21

require github.com/imfing/hextra v0.8.0 // indirect
2 changes: 2 additions & 0 deletions go.sum
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
github.com/imfing/hextra v0.8.0 h1:bG2GavmsMAgRRCrm+N4c+m6mBm9KYrgGH0mgaJpIXjM=
github.com/imfing/hextra v0.8.0/go.mod h1:cEfel3lU/bSx7lTE/+uuR4GJaphyOyiwNR3PTqFTXpI=
53 changes: 53 additions & 0 deletions hugo.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
title: Syntalos

# import hextra as module
module:
imports:
- path: github.com/imfing/hextra

markup:
# allow raw html
goldmark:
renderer:
unsafe: true

# enable hextra syntax highlight
highlight:
noClasses: false

menu:
main:
- name: Docs
pageRef: /docs
weight: 1
- name: About
pageRef: /about
weight: 2
- name: Contact ↗
url: "https://github.com/ximion"
weight: 3
- name: Search
weight: 4
params:
type: search
- name: GitHub
weight: 5
url: "https://github.com/syntalos/syntalos"
params:
icon: github

params:
navbar:
displayTitle: true
displayLogo: false

footer:
displayCopyright: true
displayPoweredBy: false

editURL:
enable: false

security:
exec:
allow: ['^asciidoctor$', '^dart-sass-embedded$', '^go$', '^npx$', '^pandoc$', '^postcss$', '^rst2html$']

0 comments on commit 1375d0b

Please sign in to comment.