generated from sig_core/wiki-template
Initial commit
This commit is contained in:
SIG/HPC
commit
062c6a0a69
41
.github/workflows/build.yml
vendored
Normal file
41
.github/workflows/build.yml
vendored
Normal file
@ -0,0 +1,41 @@
|
||||
---
|
||||
name: mkdocs build
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
container:
|
||||
image: docker.io/rockylinux:9
|
||||
steps:
|
||||
- name: Install deps
|
||||
run: dnf -y install git python3 python3-pip
|
||||
|
||||
- name: setup ssh
|
||||
env:
|
||||
SSH_KEY: "${{ secrets.SSH_KEY }}"
|
||||
run: |
|
||||
mkdir -p ~/.ssh/
|
||||
echo "$SSH_KEY" > ~/.ssh/id_rsa
|
||||
chmod 0700 ~/.ssh/
|
||||
chmod 0600 ~/.ssh/id_rsa
|
||||
|
||||
- name: checkout
|
||||
env:
|
||||
GIT_SSH_COMMAND: "ssh -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no"
|
||||
run:
|
||||
git clone https://git.resf.org/$GITHUB_REPOSITORY.git $GITHUB_WORKSPACE
|
||||
|
||||
- name: Install python requirements
|
||||
run: python3 -m pip install -r requirements.txt
|
||||
|
||||
- name: Deploy
|
||||
env:
|
||||
GIT_SSH_COMMAND: "ssh -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no"
|
||||
GIT_AUTHOR_NAME: "Rocky Bot"
|
||||
GIT_AUTHOR_EMAIL: "auto@rockylinux.org"
|
||||
run: |
|
||||
git remote set-url origin ssh://git@git.resf.org:22220/$GITHUB_REPOSITORY.git
|
||||
python3 -m mkdocs gh-deploy --force
|
||||
9
LICENSE
Normal file
9
LICENSE
Normal file
@ -0,0 +1,9 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) <year> <copyright holders>
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
7
README.md
Normal file
7
README.md
Normal file
@ -0,0 +1,7 @@
|
||||
# REPLACEME Wiki
|
||||
|
||||
@TODO - fill in :)
|
||||
|
||||
## Continuous Integration / Continuous Deployment
|
||||
|
||||
Actions Runner executes workflow to publish to https://REPLACEME.rocky.page on push to main.
|
||||
1
docs/CNAME
Normal file
1
docs/CNAME
Normal file
@ -0,0 +1 @@
|
||||
REPLACEME.rocky.page
|
||||
16
docs/index.md
Normal file
16
docs/index.md
Normal file
@ -0,0 +1,16 @@
|
||||
# REPLACEME Wiki
|
||||
|
||||
## Links
|
||||
|
||||
## Responsibilities
|
||||
|
||||
## Meetings / Communications
|
||||
|
||||
## Members
|
||||
|
||||
## Project layout
|
||||
|
||||
mkdocs.yml # The configuration file.
|
||||
docs/
|
||||
index.md # The documentation homepage.
|
||||
... # Other markdown pages, images and other files.
|
||||
78
mkdocs.yml
Normal file
78
mkdocs.yml
Normal file
@ -0,0 +1,78 @@
|
||||
---
|
||||
# Project information
|
||||
site_name: REPLACEME Wiki
|
||||
site_url: https://REPLACEME.rocky.page
|
||||
site_description: >-
|
||||
REPLACEME
|
||||
|
||||
# Repository
|
||||
repo_url: https://git.resf.org/REPLACEME/wiki
|
||||
repo_name: REPLACEME/wiki
|
||||
edit_uri: _edit/main/docs/
|
||||
|
||||
# Copyright
|
||||
copyright: Copyright © 2023 Rocky Enterprise Software Foundation
|
||||
|
||||
# Configuration
|
||||
theme:
|
||||
name: material
|
||||
logo: assets/icon-white.svg
|
||||
palette:
|
||||
- media: "(prefers-color-scheme: light)"
|
||||
scheme: default
|
||||
primary: teal
|
||||
accent: teal
|
||||
toggle:
|
||||
icon: material/weather-night
|
||||
name: Switch to dark mode
|
||||
- media: "(prefers-color-scheme: dark)"
|
||||
scheme: slate
|
||||
primary: teal
|
||||
accent: teal
|
||||
toggle:
|
||||
icon: material/weather-sunny
|
||||
name: Switch to light mode
|
||||
highlightjs: true
|
||||
hljs_languages:
|
||||
- bash
|
||||
- perl
|
||||
- python
|
||||
- yaml
|
||||
features:
|
||||
- navigation.expand
|
||||
- navigation.indexes
|
||||
- navigation.instant
|
||||
- navigation.sections
|
||||
- navigation.top
|
||||
- navigation.tracking
|
||||
- navigation.path
|
||||
- search.highlight
|
||||
- search.suggest
|
||||
- toc.integrate
|
||||
- content.action.edit
|
||||
|
||||
# Plugins
|
||||
plugins:
|
||||
- autolinks
|
||||
- awesome-pages
|
||||
- git-revision-date-localized:
|
||||
type: date
|
||||
- search
|
||||
|
||||
# Extensions
|
||||
markdown_extensions:
|
||||
- abbr
|
||||
- admonition
|
||||
- attr_list
|
||||
- def_list
|
||||
- footnotes
|
||||
- meta
|
||||
- pymdownx.details # this allows collapsible attributions
|
||||
- pymdownx.emoji:
|
||||
emoji_index: !!python/name:materialx.emoji.twemoji
|
||||
emoji_generator: !!python/name:materialx.emoji.to_svg
|
||||
- pymdownx.superfences
|
||||
- pymdownx.tabbed:
|
||||
alternate_style: true
|
||||
- toc:
|
||||
permalink: true
|
||||
7
requirements.txt
Normal file
7
requirements.txt
Normal file
@ -0,0 +1,7 @@
|
||||
mkdocs
|
||||
mkdocs-autolinks-plugin
|
||||
mkdocs-awesome-pages-plugin
|
||||
mkdocs-git-revision-date-localized-plugin
|
||||
mkdocs-macros-plugin
|
||||
mkdocs-material
|
||||
mkdocs-windmill
|
||||
Loading…
Reference in New Issue
Block a user