Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate docsite using MkDocs and publish to Github Pages #164

Closed
wants to merge 3 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions .github/workflows/pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Deploy MkDocs Site to GitHub Pages

on:
push:
branches:
- main

permissions: write-all

jobs:
build-deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3

- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: "3.x"

- name: Install Dependencies
run: pip install -r requirements.txt

- name: Build the Site
run: mkdocs build --clean

- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./site
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
**/node_modules
dist/
site/
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
54 changes: 54 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
site_name: Cashu NUTs Specifications
site_url: https://cashubtc.github.io/nuts/
theme:
name: material
features:
- navigation.expand
- navigation.sections
- navigation.top
- search.highlight
- search.share
- toc.integrate
- content.code.copy
- content.tabs.link
- announce.dismiss
palette:
- scheme: default
primary: indigo
accent: indigo
icon:
logo: material/hand-coin
nav:
- Home: README.md
- NUTs:
- Mandatory:
- NUT-00: 00.md
- NUT-01: 01.md
- NUT-02: 02.md
- NUT-03: 03.md
- NUT-04: 04.md
- NUT-05: 05.md
- NUT-06: 06.md
# Add more mandatory NUTs here
- Optional:
- NUT-07: 07.md
- NUT-08: 08.md
- NUT-09: 09.md
- NUT-10: 10.md
- NUT-11: 11.md
- NUT-12: 12.md
- NUT-13: 13.md
- NUT-14: 14.md
- NUT-15: 15.md
- NUT-16: 16.md
- NUT-17: 17.md
# Add more optional NUTs here
plugins:
- search
- macros
- section-index
markdown_extensions:
- admonition
- codehilite
- toc:
permalink: true
4 changes: 4 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
mkdocs
mkdocs-material
mkdocs-macros-plugin
mkdocs-section-index