Skip to content

Commit

Permalink
feat: create 1000kit documentation page
Browse files Browse the repository at this point in the history
  • Loading branch information
andrejpetras committed Mar 14, 2024
1 parent e4acfda commit c8ea5dd
Show file tree
Hide file tree
Showing 7 changed files with 73 additions and 0 deletions.
25 changes: 25 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Publish to GitHub Pages
on:
push:
branches: [main]
repository_dispatch:
types: [dispatch-build-website]
workflow_dispatch:
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: '20'
cache: 'npm'
- name: Install Antora
run: npm i antora
- name: Generate Site
run: npx antora antora-playbook.yml
- name: Publish to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: build/site
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
# docs

1000kit documentation
29 changes: 29 additions & 0 deletions antora-playbook.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
site:
title: 1000kit Docs
url: https://1000kit.github.io/
start_page: index::index.adoc
content:
sources:
- url: . # common module containing just the main index
branches: HEAD
# - url: https://github.com/1000kit/tkit-quarkus.git
# branches: [HEAD]
# start_path: docs
ui:
bundle:
url: https://github.com/onecx/docs-antora-ui/releases/latest/download/ui-bundle.zip
snapshot: true
supplemental_files:
- path: ui.yml
contents: |
static_files:
- .nojekyll
- path: .nojekyll
urls:
latest_version_segment: current
asciidoc:
attributes:
sourcemap: true
kroki-fetch-diagram: true
extensions:
- asciidoctor-kroki
6 changes: 6 additions & 0 deletions antora.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Descriptor of the common Antora module that contains just a landing page for the whole documentation site
name: index
title: 1000kit Docs
version: latest
nav:
- modules/ROOT/nav.adoc
Empty file added modules/ROOT/nav.adoc
Empty file.
3 changes: 3 additions & 0 deletions modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
= 1000kit documentation

Welcome to the 1000kit documentation site.
9 changes: 9 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"devDependencies": {
"@antora/cli": "3.1.7",
"@antora/site-generator": "3.1.7"
},
"dependencies": {
"asciidoctor-kroki": "^0.18.0"
}
}

0 comments on commit c8ea5dd

Please sign in to comment.