Skip to content

Commit

Permalink
Create pointer encoding webpage
Browse files Browse the repository at this point in the history
  • Loading branch information
@TollyH
TollyH committed May 28, 2024
1 parent 28c1987 commit 932a952
Show file tree
Hide file tree
Showing 7 changed files with 632 additions and 4 deletions.
21 changes: 17 additions & 4 deletions .github/workflows/static.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ on:
- "main"
paths:
- Documentation/ReferenceManual/**
- Documentation/PointerToy/**

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
Expand Down Expand Up @@ -37,7 +38,13 @@ jobs:
uses: actions/configure-pages@v5
- name: Setup PanDoc
uses: pandoc/actions/setup@main
- name: Build documentation HTML
- name: Setup Node.js 18.x
uses: actions/setup-node@v4
with:
node-version: 18.x
- name: Install dependencies
run: npm install -g typescript
- name: Build Reference Manual HTML
run: |
mkdir ./Documentation/ReferenceManual/Build
pandoc -s ./Documentation/ReferenceManual/ReferenceManual.md \
Expand All @@ -47,12 +54,18 @@ jobs:
-H ./Documentation/ReferenceManual/ReferenceManual.HtmlHeader.html \
-o ./Documentation/ReferenceManual/Build/ReferenceManual.html \
--metadata pagetitle="AssEmbly Reference Manual"
cp ./Documentation/ReferenceManual/Build/ReferenceManual.html ./Documentation/ReferenceManual/Build/index.html
- name: Build Pointer Toy
run: tsc -p ./Documentation/PointerToy/
- name: Copy artifacts
run: |
mkdir ./Documentation/PagesArtifacts
cp ./Documentation/ReferenceManual/Build/ReferenceManual.html ./Documentation/PagesArtifacts/index.html
cp ./Documentation/PointerToy/ ./Documentation/PagesArtifacts/PointerToy/
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
# Upload the built reference manual HTML
path: './Documentation/ReferenceManual/Build/'
# Upload the built reference manual and pointer toy HTML
path: './Documentation/PagesArtifacts/'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
2 changes: 2 additions & 0 deletions Documentation/PointerToy/.gitignore
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
script.js
script.min.js
137 changes: 137 additions & 0 deletions Documentation/PointerToy/index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,137 @@
<!DOCTYPE html>
<html>
<head>
<title>AssEmbly Pointer Toy</title>
<link rel="stylesheet" href="styles.css"/>
<script src="script.js"></script>
</head>
<body>
<h1>AssEmbly Pointer Toy</h1>
<div class="page-section">
<h2>Disassembled Pointer</h2>
<div id="pointer-assembly-text" class="monospace x-large bottom-margin">This webpage requires JavaScript to work</div>
<div class="margin">
<b>Mode:</b> <span id="pointer-mode"></span>
</div>
<div class="margin">
<b>Read Size:</b> <span id="pointer-read-size"></span>
</div>
<div class="margin">
<b>Length:</b> <span id="pointer-length"></span>
</div>
<h2>Assembled Bytes</h2>
<div id="pointer-assembly-bytes" class="monospace large">00</div>
</div>
<h2>Pointer Bits</h2>
<div id="pointer-first-byte" class="page-section">
<h3>First Byte</h3>
<div class="vertical-center">
<span id="pointer-first-byte-bits">
<div class="bit red" role="button">0</div>
<div class="bit red" role="button">0</div>
<div class="bit green" role="button">0</div>
<div class="bit green" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
</span>
<span class="monospace large pad">
= 0x<input id="pointer-first-byte-hex" class="hex-input grey pad" size="2" maxlength="2" value="00"/>
</span>
</div>
</div>
<div id="pointer-constant" class="page-section hidden">
<h3>Constant</h3>
<div class="vertical-center">
<span id="pointer-constant-bits">
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
</span>
<span class="monospace large pad">
= 0x<input id="pointer-constant-hex" class="hex-input grey pad" size="16" maxlength="16" value="0000000000000000"/>
</span>
</div>
</div>
<div id="pointer-register-byte" class="page-section hidden">
<h3>Register</h3>
<div class="vertical-center">
<span id="pointer-register-bits">
<div class="bit red" role="button">0</div>
<div class="bit green" role="button">0</div>
<div class="bit green" role="button">0</div>
<div class="bit green" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
<div class="bit blue" role="button">0</div>
</span>
<span class="monospace large pad">
= 0x<input id="pointer-register-hex" class="hex-input grey pad" size="2" maxlength="2" value="00"/>
</span>
</div>
</div>
</body>
</html>
Loading

0 comments on commit 932a952

Please sign in to comment.