Skip to content

Commit

Permalink
feat: init mdbook minimially destructive for repo structure
Browse files Browse the repository at this point in the history
  • Loading branch information
jcstein committed Jul 18, 2024
1 parent 33749aa commit 07b470d
Show file tree
Hide file tree
Showing 9 changed files with 140 additions and 0 deletions.
56 changes: 56 additions & 0 deletions .github/workflows/mdbook.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: Deploy mdBook site 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 only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
# Build job
build:
runs-on: ubuntu-latest
env:
MDBOOK_VERSION: 0.4.36
steps:
- uses: actions/checkout@v4
- name: Install mdBook
run: |
curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf -y | sh
rustup update
cargo install --version ${MDBOOK_VERSION} mdbook
- name: Setup Pages
id: pages
uses: actions/configure-pages@v5
- name: Build with mdBook
run: mdbook build
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./book

# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
8 changes: 8 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
book
index.html

# CIPs
cips/*.html

# WGs
wgs/*/*.html
1 change: 1 addition & 0 deletions .markdownlint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@
"code_blocks": false # Disable rule for hard tabs in code blocks
"MD013": false # Disable rule for line length
"MD033": false # Disable rule banning inline HTML
"MD025": false # Disable rule for multiple top-level headers
22 changes: 22 additions & 0 deletions book.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
[book]
authors = []
language = "en"
multilingual = false
title = "Celestia Improvement Proposals (CIPs)"
description = "The Celestia Improvement Proposal (CIP) process and CIPs."
theme = "theme"
src = "src"

[output.html]
default-theme = "light"
preferred-dark-theme = "ayu"
git-repository-url = "https://github.com/celestiaorg/cips"
git-repository-icon = "fa-github"
edit-url-template = "https://github.com/celestiaorg/cips/edit/main/{path}"
cname = "cips.celestia.org"
smart-punctuation = true
theme = "theme"

[output.html.fold]
enable = false
level = 0
41 changes: 41 additions & 0 deletions src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Summary


[README.md](../README.md)

# CIPs
- [CIP-1](../cips/cip-1.md)
- [CIP-2](../cips/cip-2.md)
- [CIP-3](../cips/cip-3.md)
- [CIP-4](../cips/cip-4.md)
- [CIP-5](../cips/cip-5.md)
- [CIP-6](../cips/cip-6.md)
- [CIP-7](../cips/cip-7.md)
- [CIP-8](../cips/cip-8.md)
- [CIP-9](../cips/cip-9.md)
- [CIP-10](../cips/cip-10.md)
- [CIP-11](../cips/cip-11.md)
- [CIP-12](../cips/cip-12.md)
- [CIP-13](../cips/cip-13.md)
- [CIP-14](../cips/cip-14.md)
- [CIP-15](../cips/cip-15.md)
- [CIP-16](../cips/cip-16.md)
- [CIP-17](../cips/cip-17.md)
- [CIP-18](../cips/cip-18.md)
- [CIP-19](../cips/cip-19.md)
- [CIP-20](../cips/cip-20.md)
- [CIP-21](../cips/cip-21.md)
- [CIP-22](../cips/cip-22.md)
- [CIP-23](../cips/cip-23.md)

# CIP template

- [CIP Template](../cips/cip-template.md)

# Working Groups

- [WGs overview](../wgs/README.md)
- [Data Availability](../wgs/da/README.md)
- [Interface](../wgs/interface/README.md)
- [zk](../wgs/zk/README.md)
- [Overview of ZK Accounts](../wgs/zk/overview.md)
Binary file added theme/favicon.ico
Binary file not shown.
Binary file added theme/favicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 11 additions & 0 deletions theme/favicon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions theme/head.hbs
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<script defer data-domain="cips.celestia.org" src="https://plausible.io/js/plausible.js"></script>

0 comments on commit 07b470d

Please sign in to comment.