Skip to content

Commit

Permalink
Added Hugo rendering workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
fproulx-boostsecurity committed May 22, 2024
1 parent 8aff818 commit 04b97d3
Show file tree
Hide file tree
Showing 428 changed files with 24,364 additions and 0 deletions.
1 change: 1 addition & 0 deletions .github/workflows/build_test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ on:
branches: [ main ]
pull_request:
branches: [ main ]
paths-ignore: [ 'docs/**' ]
permissions:
contents: read

Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/pop.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ on:
paths:
- .github/workflows/**
- action.yml
paths-ignore:
- 'docs/**'

permissions: {}

Expand Down
Empty file added docs/.hugo_build.lock
Empty file.
5 changes: 5 additions & 0 deletions docs/archetypes/default.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
+++
title = '{{ replace .File.ContentBaseName "-" " " | title }}'
date = {{ .Date }}
draft = true
+++
5 changes: 5 additions & 0 deletions docs/content/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: "poutine"
---

This is the documentation for the [poutine](https://github.com/boostsecurityio/poutine) project.
6 changes: 6 additions & 0 deletions docs/data/menu/extra.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
header:
- name: GitHub
ref: https://github.com/boostsecurityio/poutine
icon: gdoc_github
external: true
11 changes: 11 additions & 0 deletions docs/data/menu/more.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
more:
- name: Releases
ref: "https://github.com/boostsecurityio/poutine/releases"
external: true
icon: "gdoc_download"
- name: GitHub
ref: "https://github.com/boostsecurityio/poutine"
external: true
icon: "gdoc_github"

30 changes: 30 additions & 0 deletions docs/hugo.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
baseURL = 'https://boostsecurityio.github.io/poutine/'
languageCode = 'en-us'
title = 'poutine'
theme = "hugo-geekdoc"

pluralizeListTitles = false

# Geekdoc required configuration
#pygmentsUseClasses = true
pygmentsUseClasses = false
pygmentsCodeFences = true
disablePathToLower = true
# geekdocFileTreeSortBy = "linkTitle"

# Required if you want to render robots.txt template
enableRobotsTXT = true

# Needed for mermaid shortcodes
[markup]
[markup.goldmark.renderer]
# Needed for mermaid shortcode
unsafe = true
[markup.tableOfContents]
startLevel = 1
endLevel = 9
[markup.highlight]
style = 'solarized-dark'

[taxonomies]
tag = "tags"
264 changes: 264 additions & 0 deletions docs/public/404.html

Large diffs are not rendered by default.

Loading

0 comments on commit 04b97d3

Please sign in to comment.