Add mkdocs webpage

This commit is contained in:
Mustafa Gezen 2023-03-02 18:31:59 +01:00
parent fae33ec2b0
commit 0bed9c3b7c
7 changed files with 4433 additions and 0 deletions

38
.github/workflows/web.yaml vendored Normal file
View File

@ -0,0 +1,38 @@
name: Deploy web 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 one concurrent deployment
concurrency:
group: "pages"
cancel-in-progress: true
jobs:
# Single deploy job since we're just deploying
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Deploy docs
uses: mhausenblas/mkdocs-deploy-gh-pages@master
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
CUSTOM_DOMAIN: distro-tools.rocky.page
CONFIG_FILE: web/mkdocs.yaml
REQUIREMENTS: web/requirements.txt

4
web/docs/.pages Normal file
View File

@ -0,0 +1,4 @@
---
nav:
- ... | index.md
- Apollo: apollo

4295
web/docs/apollo/openapi.md Normal file

File diff suppressed because it is too large Load Diff

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 26 KiB

8
web/docs/index.md Normal file
View File

@ -0,0 +1,8 @@
---
title: Home
---
# distro-tools
# About
Documentation for tools/services in the distro-tools repository.

73
web/mkdocs.yml Normal file
View File

@ -0,0 +1,73 @@
---
# Project information
site_name: Distro Tools
site_url: https://distro-tools.rocky.page
site_description: >-
Distribution building tools from the RESF. Used to build Rocky Linux
# Repository
repo_url: https://github.com/resf/distro-tools
repo_name: resf/distro-tools
# Copyright
copyright: Copyright © 2023 Rocky Enterprise Software Foundation
# Configuration
theme:
name: material
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.tabs
- navigation.top
- navigation.tracking
- search.highlight
- search.suggest
- toc.integrate
logo: assets/icon-white.svg
# Plugins
plugins:
- autolinks
- awesome-pages
- git-revision-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
web/requirements.txt Normal file
View File

@ -0,0 +1,7 @@
mkdocs
mkdocs-autolinks-plugin
mkdocs-awesome-pages-plugin
mkdocs-git-revision-date-plugin
mkdocs-macros-plugin
mkdocs-material
mkdocs-windmill