Skip to content

Commit 7b0b5f8

Browse files
authored
Revamp "The Timing of LYC STAT Handlers" article (#42)
* Remove single quotation marks Use single quotes or code blocks where appropriate instead * Use bold text instead of anchor in Pan Docs quote Avoids polluting the ToC * Fix whitespace formatting * Rename "Hblank" to "HBlank" To be consistent with Pan Docs' style guide https://github.com/gbdev/pandocs/wiki/Document-Style#6-horizontal-blanking-interval-vertical-blanking-interval * Set indentation to 4 spaces 8 is typically too much in <pre> blocks on the Web * Use constants present in `hardware.inc` * Make code style consistent Should improve readability * Add DeadCScroll GIF to showcase a raster FX example Should help ground the introduction * Remove "r" prefix from reg names in prose Those are not part of their names, and rather indicate addresses * Use monospaced text for all reg names and instructions in prose * Update DeadCScroll to point to new gbdev.io version * Convert scanline timing diagrams to <table> They should be somewhat more readable, though there is still romm for improvement * Set "..." cells background to represent the different modes Not just the one it starts on, but all that it goes through * Correct io-3cycle "gradient" to fix off-by-one pixel * Hoist code blocks to separate files This will allow the next change to pull some of the lines programmatically * Make all "timelines" load ASM lines This will propagate modifications made to one to the other as well. Additionally, this uncovered a couple of slip-ups, which were corrected. * Use a SVG for the PPU timing diagram And make it follow the theme as well, of course! * Make ASM import paths use alias Shorter and independent of the `.temp` folder location * Improve timelines color palette Use a set of colorblind-friendly colors Do not color IO instructions specially besides their important cycle Make the specific IO cycle pop out more Only label that specific cycle in the legend * Mark "condensed" rows more explicitly as such Add "..." to imply their purpose more strongly, and make that bold to make it stand out a bit more against the background * Rename "skip" to "condensed" That's a much more accurate label * Document a non-obvious purpose of the PPU mode color vars * Error out when referencing an unregistered ASM file * Report ASM file location when a relevant error occurs * Fix removal of comments in ASM files It would *remove* everything before the semicolon, which is the opposite of what we want * Sort timeline legends chronologically Makes them easier to read, since entries are introduced in the same order that they are in the timeline being labelled * [WIP] Overhaul article contents
1 parent cafa23d commit 7b0b5f8

19 files changed

Lines changed: 1115 additions & 235 deletions

package-lock.json

Lines changed: 30 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@
1717
"homepage": "https://gbdev.io",
1818
"devDependencies": {
1919
"@vuepress/plugin-shiki": "^2.0.0-beta.32",
20+
"vite-raw-plugin": "^1.0.1",
21+
"vue-inline-svg": "^3.1.0",
2022
"vuepress": "^2.0.0-beta.32"
2123
}
2224
}

website/.vuepress/config.js

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
// .vuepress/config.js
22

33
const { path } = require("@vuepress/utils");
4+
const markdownRawPlugin = require('vite-raw-plugin');
45

56
module.exports = {
67
plugins: [
@@ -54,5 +55,19 @@ module.exports = {
5455
]
5556
}
5657
]
57-
}
58+
},
59+
60+
bundler: '@vuepress/bundler-vite',
61+
bundlerConfig: {
62+
viteOptions: {
63+
plugins: [
64+
markdownRawPlugin({ fileRegex: /\.asm$/ }),
65+
],
66+
resolve: {
67+
alias: {
68+
'@': __dirname, // Alias to the `.vuepress` folder
69+
},
70+
},
71+
},
72+
},
5873
}
-95.5 KB
Binary file not shown.
-128 KB
Binary file not shown.
-111 KB
Binary file not shown.
-107 KB
Binary file not shown.
-110 KB
Binary file not shown.
-118 KB
Binary file not shown.
-101 KB
Binary file not shown.

0 commit comments

Comments
 (0)