Skip to content
Merged
Show file tree
Hide file tree
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
51 changes: 51 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# From https://vitepress.dev/guide/deploy#github-pages.
name: Deploy VitePress site to GitHub Pages
on:
push:
branches:
- 'main'
- 'eng-78'
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: pages
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: 'Checkout'
uses: actions/checkout@v5
with:
fetch-depth:
- name: Setup Node
uses: actions/setup-node@v6
with:
node-version: 24
cache: npm
cache-dependency-path: docs/package-lock.json
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Install dependencies
run: npm ci
working-directory: docs
- name: Build with VitePress
run: npm run build
working-directory: docs
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: docs/.vitepress/dist
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
needs: build
runs-on: ubuntu-latest
name: Deploy
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,23 @@

*Courtesy of Distributed Atomic State Machine Algorithms Corporation (DASMAC)*

The Solana Opcode Guide is made with GitHub pages and can be viewed at
[opcodes.dasmac.com].
The Solana Opcode Guide can be viewed at [opcodes.dasmac.com].

[opcodes.dasmac.com]: https://opcodes.dasmac.com

## Local Deployment

1. Ensure you have [`bundle`] and [`jekyll`].
1. Run:
1. Navigate to the docs directory:

```sh
cd docs
bundle install
bundle exec jekyll serve --baseurl="" --livereload
```

1. Open <http://localhost:4000>.
1. Install dependencies and run dev server:

[`bundle`]: https://bundler.io/
[`jekyll`]: https://jekyllrb.com/docs/installation/
```sh
npm install
npm run dev
```

1. Open <localhost:5173>.
4 changes: 2 additions & 2 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
_site
Gemfile.lock
.vitepress/cache
node_modules
9 changes: 9 additions & 0 deletions docs/.vitepress/config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
export default {
title: 'Solana Opcode Guide',
themeConfig: {
sidebar: [
{ text: 'Welcome', link: '/' },
{ text: 'Quickstart', link: '/quickstart' }
]
}
}
2 changes: 0 additions & 2 deletions docs/Gemfile

This file was deleted.

2 changes: 0 additions & 2 deletions docs/_config.yml

This file was deleted.

7 changes: 1 addition & 6 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
---
title: Welcome
nav_order: 1
---

# Solana Opcode Guide

*Courtesy of Distributed Atomic State Machine Algorithms Corporation (DASMAC)*
Expand Down Expand Up @@ -64,7 +59,7 @@ the constant [`JLT_REG`] from the [SBPF opcodes].

## Continue your journey

Head over to the [Quickstart]({% link quickstart.md %})!
Head over to the [Quickstart](quickstart)!

[`jlt_reg`]: https://docs.rs/solana-sbpf/latest/solana_sbpf/ebpf/constant.JLT_REG.html
[anchor]: https://www.anchor-lang.com/docs
Expand Down
Loading