Skip to content

Commit

Permalink
add mdbook
Browse files Browse the repository at this point in the history
  • Loading branch information
mmmray committed Aug 11, 2024
1 parent 765328f commit 55d0f4e
Show file tree
Hide file tree
Showing 6 changed files with 70 additions and 3 deletions.
50 changes: 50 additions & 0 deletions .github/workflows/pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: Deploy

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:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Setup Pages
uses: actions/configure-pages@v1
- run: |
mkdir bin
curl -sSL https://github.com/rust-lang/mdBook/releases/download/v0.4.40/mdbook-v0.4.40-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=bin
bin/mdbook build
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
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@v1
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/book
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
Random articles I wrote.
Random articles I ([mmmray](https://github.com/mmmray)) wrote.

The site is available in two forms: As a bunch of [Markdown files on GitHub](https://github.com/mmmray/wall-documents), and [as a real website](https://mmmray.github.io/wall-documents/).

All articles are licensed as
[CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/deed.en). If you have a
translation I am happy to link it.
translation I am happy to link or host it here.
8 changes: 8 additions & 0 deletions SUMMARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Summary

[Introduction](./README.md)

# Articles

- [Introduction to V2ray Transports](./transports.md)
- [Issues with Xray Panels](./panels.md)
6 changes: 6 additions & 0 deletions book.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[book]
authors = ["mmmray"]
language = "en"
multilingual = false
src = "."
title = "mmmray documents"
2 changes: 1 addition & 1 deletion transports.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Introduction to v2ray transports
# Introduction to V2ray Transports

*2024-08-01*

Expand Down

0 comments on commit 55d0f4e

Please sign in to comment.