@@ -17,7 +18,7 @@ const { title, date, author, tag } = Astro.props;
{date.toLocaleDateString("en-US", { timeZone: 'UTC' })}
•
-
{author}
+
{authorName ?? authorGithub}
•
{tag}
diff --git a/src/components/FileTree.astro b/src/components/FileTree.astro
new file mode 100644
index 0000000..888c600
--- /dev/null
+++ b/src/components/FileTree.astro
@@ -0,0 +1,144 @@
+---
+import { fileTree } from "./fileTree.ts";
+import { rehype } from "rehype";
+
+/** Rehype processor to extract file tree data and turn each entry into its associated markup. */
+const fileTreeProcessor = rehype()
+ .data('settings', { fragment: true })
+ .use(fileTree);
+
+const html = fileTreeProcessor.processSync({ data: { directoryLabel: "Hi" }, value: await Astro.slots.render("default") }).toString();
+---
+
+
+
+
diff --git a/src/components/MarkdownStyles.astro b/src/components/MarkdownStyles.astro
index 9e31928..bb50604 100644
--- a/src/components/MarkdownStyles.astro
+++ b/src/components/MarkdownStyles.astro
@@ -188,19 +188,19 @@ const { element: Element = "div", class: className, ...rest } = Astro.props;
font-family: var(--font-primary);
}
.markdown-body :global(pre.shaku .line.diff-insert) {
- background-color: rgba(126, 231, 135, 0.1);
+ background-color: hsl(var(--accent-green-hue), 69%, 70%, 0.1);
}
.markdown-body :global(pre.shaku .line.diff-insert::before) {
content: "+";
- color: #7ee787;
+ color: hsl(var(--accent-green-hue), 69%, 70%);
}
.markdown-body :global(pre.shaku .line.diff-delete) {
opacity: 0.5;
- background-color: rgba(248, 81, 73, 0.1);
+ background-color: hsl(var(--accent-red-hue), 93%, 63%, 0.1);
}
.markdown-body :global(pre.shaku .line.diff-delete::before) {
content: "-";
- color: rgb(248, 81, 73);
+ color: hsl(var(--accent-red-hue), 93%, 63%);
}
.markdown-body :global(.shaku-inline-highlight) {
@@ -209,6 +209,14 @@ const { element: Element = "div", class: className, ...rest } = Astro.props;
background-color: hsl(var(--accent-yellow-hue), 73%, 63%, 0.15);
}
+ .markdown-body :global(.line.diff-delete .shaku-inline-highlight) {
+ background-color: hsl(var(--accent-red-hue), 73%, 63%, 0.25);
+ }
+
+ .markdown-body :global(.line.diff-insert .shaku-inline-highlight) {
+ background-color: hsl(var(--accent-green-hue), 73%, 63%, 0.25);
+ }
+
.markdown-body :global(.shaku-inline-highlight[data-id="err"]) {
print-color-adjust: exact;
-webkit-print-color-adjust: exact;
@@ -216,6 +224,11 @@ const { element: Element = "div", class: className, ...rest } = Astro.props;
}
.markdown-body :global(pre.shaku .line.dim) {
+ transition: filter 0.25s ease;
+ filter: blur(0) brightness(0.6);
+ }
+
+ .markdown-body :global(pre.shaku:not(:hover) .line.dim) {
filter: blur(2px) brightness(0.5);
}
@@ -389,39 +402,6 @@ const { element: Element = "div", class: className, ...rest } = Astro.props;
display: block;
}
- .markdown-body :global(.code-split) {
- display: flex;
- flex-wrap: wrap;
- flex-basis: content;
- gap: 1px;
- background-color: var(--background-secondary);
- border: 1px solid var(--background-secondary);
- margin-block: 24px;
- border-radius: 4px;
- overflow: hidden;
- }
-
- .markdown-body :global(.code-split.error) {
- background-color: hsl(1deg 76% 78% / 50%);
- border-color: hsl(1deg 76% 78% / 50%);
- }
-
- .markdown-body :global(.code-split pre) {
- margin-block: 0;
- flex: 1 1 auto;
- border-radius: 0;
- border: 0;
- }
-
- .markdown-body :global(.code-split pre:first-child) {
- border-left: none;
- }
-
- .markdown-body :global(.code-split.error pre:last-of-type) {
- text-wrap: wrap;
- background-color: #372930 !important;
- }
-
.markdown-body :global(table) {
text-align: left;
border-collapse: collapse;
@@ -453,6 +433,21 @@ const { element: Element = "div", class: className, ...rest } = Astro.props;
display: block;
}
+ .markdown-body :global(small) {
+ max-width: 600px;
+ display: block;
+ text-align: center;
+ margin: 12px auto;
+ }
+
+ /* .markdown-body :global(details[open] summary) {
+ display: none;
+ } */
+
+ /* .markdown-body :global(details summary) {
+ cursor: pointer;
+ } */
+
@media print {
.markdown-body :global(.markdown-alert),
.markdown-body :global(blockquote),
diff --git a/src/components/SplitCodeblock.astro b/src/components/SplitCodeblock.astro
new file mode 100644
index 0000000..59cb913
--- /dev/null
+++ b/src/components/SplitCodeblock.astro
@@ -0,0 +1,50 @@
+---
+const {
+ error = false,
+ vertical = false,
+} = Astro.props;
+---
+
+
+
+
+
+
\ No newline at end of file
diff --git a/src/components/fileTree.ts b/src/components/fileTree.ts
new file mode 100644
index 0000000..9d5987d
--- /dev/null
+++ b/src/components/fileTree.ts
@@ -0,0 +1,986 @@
+import { AstroError } from 'astro/errors';
+import { type Child, h, s } from 'hastscript';
+import { select } from 'hast-util-select';
+import { fromHtml } from 'hast-util-from-html';
+import { toString } from 'hast-util-to-string';
+import { CONTINUE, SKIP, visit } from 'unist-util-visit';
+import type { Element } from 'hast';
+
+/**
+ * Based on https://github.com/elviswolcott/seti-icons which
+ * is derived from https://github.com/jesseweed/seti-ui/
+ *
+ * Copyright (c) 2014 Jesse Weed
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of this software and associated documentation files (the
+ * "Software"), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+ * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+ * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+ * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+export const definitions: Definitions = {
+ files: {
+ 'astro.config.js': 'astro',
+ 'astro.config.mjs': 'astro',
+ 'astro.config.cjs': 'astro',
+ 'astro.config.ts': 'astro',
+ 'pnpm-debug.log': 'pnpm',
+ 'pnpm-lock.yaml': 'pnpm',
+ 'pnpm-workspace.yaml': 'pnpm',
+ 'biome.json': 'biome',
+ 'bun.lockb': 'bun',
+ COMMIT_EDITMSG: 'seti:git',
+ MERGE_MSG: 'seti:git',
+ 'karma.conf.js': 'seti:karma',
+ 'karma.conf.cjs': 'seti:karma',
+ 'karma.conf.mjs': 'seti:karma',
+ 'karma.conf.coffee': 'seti:karma',
+ 'README.md': 'seti:info',
+ 'README.txt': 'seti:info',
+ README: 'seti:info',
+ 'CHANGELOG.md': 'seti:clock',
+ 'CHANGELOG.txt': 'seti:clock',
+ CHANGELOG: 'seti:clock',
+ 'CHANGES.md': 'seti:clock',
+ 'CHANGES.txt': 'seti:clock',
+ CHANGES: 'seti:clock',
+ 'VERSION.md': 'seti:clock',
+ 'VERSION.txt': 'seti:clock',
+ VERSION: 'seti:clock',
+ mvnw: 'seti:maven',
+ 'pom.xml': 'seti:maven',
+ 'tsconfig.json': 'seti:tsconfig',
+ 'vite.config.js': 'seti:vite',
+ 'vite.config.ts': 'seti:vite',
+ 'vite.config.mjs': 'seti:vite',
+ 'vite.config.mts': 'seti:vite',
+ 'vite.config.cjs': 'seti:vite',
+ 'vite.config.cts': 'seti:vite',
+ 'swagger.json': 'seti:json',
+ 'swagger.yml': 'seti:json',
+ 'swagger.yaml': 'seti:json',
+ 'mime.types': 'seti:config',
+ Jenkinsfile: 'seti:jenkins',
+ 'babel.config.js': 'seti:babel',
+ 'babel.config.json': 'seti:babel',
+ 'babel.config.cjs': 'seti:babel',
+ BUILD: 'seti:bazel',
+ 'BUILD.bazel': 'seti:bazel',
+ WORKSPACE: 'seti:bazel',
+ 'WORKSPACE.bazel': 'seti:bazel',
+ 'bower.json': 'seti:bower',
+ 'Bower.json': 'seti:bower',
+ 'eslint.config.js': 'seti:eslint',
+ 'firebase.json': 'seti:firebase',
+ geckodriver: 'seti:firefox',
+ 'Gruntfile.js': 'seti:grunt',
+ 'gruntfile.babel.js': 'seti:grunt',
+ 'Gruntfile.babel.js': 'seti:grunt',
+ 'gruntfile.js': 'seti:grunt',
+ 'Gruntfile.coffee': 'seti:grunt',
+ 'gruntfile.coffee': 'seti:grunt',
+ 'ionic.config.json': 'seti:ionic',
+ 'Ionic.config.json': 'seti:ionic',
+ 'ionic.project': 'seti:ionic',
+ 'Ionic.project': 'seti:ionic',
+ 'platformio.ini': 'seti:platformio',
+ 'rollup.config.js': 'seti:rollup',
+ 'sass-lint.yml': 'seti:sass',
+ 'stylelint.config.js': 'seti:stylelint',
+ 'stylelint.config.cjs': 'seti:stylelint',
+ 'stylelint.config.mjs': 'seti:stylelint',
+ 'yarn.clean': 'seti:yarn',
+ 'yarn.lock': 'seti:yarn',
+ 'webpack.config.js': 'seti:webpack',
+ 'webpack.config.cjs': 'seti:webpack',
+ 'webpack.config.mjs': 'seti:webpack',
+ 'webpack.config.ts': 'seti:webpack',
+ 'webpack.config.build.js': 'seti:webpack',
+ 'webpack.config.build.cjs': 'seti:webpack',
+ 'webpack.config.build.mjs': 'seti:webpack',
+ 'webpack.config.build.ts': 'seti:webpack',
+ 'webpack.common.js': 'seti:webpack',
+ 'webpack.common.cjs': 'seti:webpack',
+ 'webpack.common.mjs': 'seti:webpack',
+ 'webpack.common.ts': 'seti:webpack',
+ 'webpack.dev.js': 'seti:webpack',
+ 'webpack.dev.cjs': 'seti:webpack',
+ 'webpack.dev.mjs': 'seti:webpack',
+ 'webpack.dev.ts': 'seti:webpack',
+ 'webpack.prod.js': 'seti:webpack',
+ 'webpack.prod.cjs': 'seti:webpack',
+ 'webpack.prod.mjs': 'seti:webpack',
+ 'webpack.prod.ts': 'seti:webpack',
+ 'npm-debug.log': 'seti:npm_ignored',
+ },
+ extensions: {
+ '.astro': 'astro',
+ '.mdx': 'mdx',
+ '.pkl': 'pkl',
+ '.bsl': 'seti:bsl',
+ '.mdo': 'seti:mdo',
+ '.cls': 'seti:salesforce',
+ '.apex': 'seti:salesforce',
+ '.asm': 'seti:asm',
+ '.s': 'seti:asm',
+ '.bicep': 'seti:bicep',
+ '.bzl': 'seti:bazel',
+ '.bazel': 'seti:bazel',
+ '.BUILD': 'seti:bazel',
+ '.WORKSPACE': 'seti:bazel',
+ '.bazelignore': 'seti:bazel',
+ '.bazelversion': 'seti:bazel',
+ '.c': 'seti:c',
+ '.h': 'seti:c',
+ '.m': 'seti:c',
+ '.cs': 'seti:c-sharp',
+ '.cshtml': 'seti:html',
+ '.aspx': 'seti:html',
+ '.ascx': 'seti:html',
+ '.asax': 'seti:html',
+ '.master': 'seti:html',
+ '.cc': 'seti:cpp',
+ '.cpp': 'seti:cpp',
+ '.cxx': 'seti:cpp',
+ '.c++': 'seti:cpp',
+ '.hh': 'seti:cpp',
+ '.hpp': 'seti:cpp',
+ '.hxx': 'seti:cpp',
+ '.h++': 'seti:cpp',
+ '.mm': 'seti:cpp',
+ '.clj': 'seti:clojure',
+ '.cljs': 'seti:clojure',
+ '.cljc': 'seti:clojure',
+ '.edn': 'seti:clojure',
+ '.cfc': 'seti:coldfusion',
+ '.cfm': 'seti:coldfusion',
+ '.coffee': 'seti:cjsx',
+ '.litcoffee': 'seti:cjsx',
+ '.config': 'seti:config',
+ '.cfg': 'seti:config',
+ '.conf': 'seti:config',
+ '.cr': 'seti:crystal',
+ '.ecr': 'seti:crystal_embedded',
+ '.slang': 'seti:crystal_embedded',
+ '.cson': 'seti:json',
+ '.css': 'seti:css',
+ '.css.map': 'seti:css',
+ '.sss': 'seti:css',
+ '.csv': 'seti:csv',
+ '.xls': 'seti:xls',
+ '.xlsx': 'seti:xls',
+ '.cu': 'seti:cu',
+ '.cuh': 'seti:cu',
+ '.hu': 'seti:cu',
+ '.cake': 'seti:cake',
+ '.ctp': 'seti:cake_php',
+ '.d': 'seti:d',
+ '.doc': 'seti:word',
+ '.docx': 'seti:word',
+ '.ejs': 'seti:ejs',
+ '.ex': 'seti:elixir',
+ '.exs': 'seti:elixir_script',
+ '.elm': 'seti:elm',
+ '.ico': 'seti:favicon',
+ '.fs': 'seti:f-sharp',
+ '.fsx': 'seti:f-sharp',
+ '.gitignore': 'seti:git',
+ '.gitconfig': 'seti:git',
+ '.gitkeep': 'seti:git',
+ '.gitattributes': 'seti:git',
+ '.gitmodules': 'seti:git',
+ '.go': 'seti:go',
+ '.slide': 'seti:go',
+ '.article': 'seti:go',
+ '.gd': 'seti:godot',
+ '.godot': 'seti:godot',
+ '.tres': 'seti:godot',
+ '.tscn': 'seti:godot',
+ '.gradle': 'seti:gradle',
+ '.groovy': 'seti:grails',
+ '.gsp': 'seti:grails',
+ '.gql': 'seti:graphql',
+ '.graphql': 'seti:graphql',
+ '.graphqls': 'seti:graphql',
+ '.hack': 'seti:hacklang',
+ '.haml': 'seti:haml',
+ '.handlebars': 'seti:mustache',
+ '.hbs': 'seti:mustache',
+ '.hjs': 'seti:mustache',
+ '.hs': 'seti:haskell',
+ '.lhs': 'seti:haskell',
+ '.hx': 'seti:haxe',
+ '.hxs': 'seti:haxe',
+ '.hxp': 'seti:haxe',
+ '.hxml': 'seti:haxe',
+ '.html': 'seti:html',
+ '.jade': 'seti:jade',
+ '.java': 'seti:java',
+ '.class': 'seti:java',
+ '.classpath': 'seti:java',
+ '.properties': 'seti:java',
+ '.js': 'seti:javascript',
+ '.js.map': 'seti:javascript',
+ '.cjs': 'seti:javascript',
+ '.cjs.map': 'seti:javascript',
+ '.mjs': 'seti:javascript',
+ '.mjs.map': 'seti:javascript',
+ '.spec.js': 'seti:javascript',
+ '.spec.cjs': 'seti:javascript',
+ '.spec.mjs': 'seti:javascript',
+ '.test.js': 'seti:javascript',
+ '.test.cjs': 'seti:javascript',
+ '.test.mjs': 'seti:javascript',
+ '.es': 'seti:javascript',
+ '.es5': 'seti:javascript',
+ '.es6': 'seti:javascript',
+ '.es7': 'seti:javascript',
+ '.jinja': 'seti:jinja',
+ '.jinja2': 'seti:jinja',
+ '.json': 'seti:json',
+ '.jl': 'seti:julia',
+ '.kt': 'seti:kotlin',
+ '.kts': 'seti:kotlin',
+ '.dart': 'seti:dart',
+ '.less': 'seti:json',
+ '.liquid': 'seti:liquid',
+ '.ls': 'seti:livescript',
+ '.lua': 'seti:lua',
+ '.markdown': 'seti:markdown',
+ '.md': 'seti:markdown',
+ '.argdown': 'seti:argdown',
+ '.ad': 'seti:argdown',
+ '.mustache': 'seti:mustache',
+ '.stache': 'seti:mustache',
+ '.nim': 'seti:nim',
+ '.nims': 'seti:nim',
+ '.github-issues': 'seti:github',
+ '.ipynb': 'seti:notebook',
+ '.njk': 'seti:nunjucks',
+ '.nunjucks': 'seti:nunjucks',
+ '.nunjs': 'seti:nunjucks',
+ '.nunj': 'seti:nunjucks',
+ '.njs': 'seti:nunjucks',
+ '.nj': 'seti:nunjucks',
+ '.npm-debug.log': 'seti:npm',
+ '.npmignore': 'seti:npm',
+ '.npmrc': 'seti:npm',
+ '.ml': 'seti:ocaml',
+ '.mli': 'seti:ocaml',
+ '.cmx': 'seti:ocaml',
+ '.cmxa': 'seti:ocaml',
+ '.odata': 'seti:odata',
+ '.pl': 'seti:perl',
+ '.php': 'seti:php',
+ '.php.inc': 'seti:php',
+ '.pipeline': 'seti:pipeline',
+ '.pddl': 'seti:pddl',
+ '.plan': 'seti:plan',
+ '.happenings': 'seti:happenings',
+ '.ps1': 'seti:powershell',
+ '.psd1': 'seti:powershell',
+ '.psm1': 'seti:powershell',
+ '.prisma': 'seti:prisma',
+ '.pug': 'seti:pug',
+ '.pp': 'seti:puppet',
+ '.epp': 'seti:puppet',
+ '.purs': 'seti:purescript',
+ '.py': 'seti:python',
+ '.jsx': 'seti:react',
+ '.spec.jsx': 'seti:react',
+ '.test.jsx': 'seti:react',
+ '.cjsx': 'seti:react',
+ '.tsx': 'seti:react',
+ '.spec.tsx': 'seti:react',
+ '.test.tsx': 'seti:react',
+ '.res': 'seti:rescript',
+ '.resi': 'seti:rescript',
+ '.R': 'seti:R',
+ '.rmd': 'seti:R',
+ '.rb': 'seti:ruby',
+ '.erb': 'seti:html',
+ '.erb.html': 'seti:html',
+ '.html.erb': 'seti:html',
+ '.rs': 'seti:rust',
+ '.sass': 'seti:sass',
+ '.scss': 'seti:sass',
+ '.springBeans': 'seti:spring',
+ '.slim': 'seti:slim',
+ '.smarty.tpl': 'seti:smarty',
+ '.tpl': 'seti:smarty',
+ '.sbt': 'seti:sbt',
+ '.scala': 'seti:scala',
+ '.sol': 'seti:ethereum',
+ '.styl': 'seti:stylus',
+ '.svelte': 'seti:svelte',
+ '.swift': 'seti:swift',
+ '.sql': 'seti:db',
+ '.soql': 'seti:db',
+ '.tf': 'seti:terraform',
+ '.tf.json': 'seti:terraform',
+ '.tfvars': 'seti:terraform',
+ '.tfvars.json': 'seti:terraform',
+ '.tex': 'seti:tex',
+ '.sty': 'seti:tex',
+ '.dtx': 'seti:tex',
+ '.ins': 'seti:tex',
+ '.txt': 'seti:default',
+ '.toml': 'seti:config',
+ '.twig': 'seti:twig',
+ '.ts': 'seti:typescript',
+ '.spec.ts': 'seti:typescript',
+ '.test.ts': 'seti:typescript',
+ '.vala': 'seti:vala',
+ '.vapi': 'seti:vala',
+ '.component': 'seti:html',
+ '.vue': 'seti:vue',
+ '.wasm': 'seti:wasm',
+ '.wat': 'seti:wat',
+ '.xml': 'seti:xml',
+ '.yml': 'seti:yml',
+ '.yaml': 'seti:yml',
+ '.pro': 'seti:prolog',
+ '.zig': 'seti:zig',
+ '.jar': 'seti:zip',
+ '.zip': 'seti:zip',
+ '.wgt': 'seti:wgt',
+ '.ai': 'seti:illustrator',
+ '.psd': 'seti:photoshop',
+ '.pdf': 'seti:pdf',
+ '.eot': 'seti:font',
+ '.ttf': 'seti:font',
+ '.woff': 'seti:font',
+ '.woff2': 'seti:font',
+ '.otf': 'seti:font',
+ '.avif': 'seti:image',
+ '.gif': 'seti:image',
+ '.jpg': 'seti:image',
+ '.jpeg': 'seti:image',
+ '.png': 'seti:image',
+ '.pxm': 'seti:image',
+ '.svg': 'seti:svg',
+ '.svgx': 'seti:image',
+ '.tiff': 'seti:image',
+ '.webp': 'seti:image',
+ '.sublime-project': 'seti:sublime',
+ '.sublime-workspace': 'seti:sublime',
+ '.code-search': 'seti:code-search',
+ '.sh': 'seti:shell',
+ '.zsh': 'seti:shell',
+ '.fish': 'seti:shell',
+ '.zshrc': 'seti:shell',
+ '.bashrc': 'seti:shell',
+ '.mov': 'seti:video',
+ '.ogv': 'seti:video',
+ '.webm': 'seti:video',
+ '.avi': 'seti:video',
+ '.mpg': 'seti:video',
+ '.mp4': 'seti:video',
+ '.mp3': 'seti:audio',
+ '.ogg': 'seti:audio',
+ '.wav': 'seti:audio',
+ '.flac': 'seti:audio',
+ '.3ds': 'seti:svg',
+ '.3dm': 'seti:svg',
+ '.stl': 'seti:svg',
+ '.obj': 'seti:svg',
+ '.dae': 'seti:svg',
+ '.bat': 'seti:windows',
+ '.cmd': 'seti:windows',
+ '.babelrc': 'seti:babel',
+ '.babelrc.js': 'seti:babel',
+ '.babelrc.cjs': 'seti:babel',
+ '.bazelrc': 'seti:bazel',
+ '.bowerrc': 'seti:bower',
+ '.codeclimate.yml': 'seti:code-climate',
+ '.eslintrc': 'seti:eslint',
+ '.eslintrc.js': 'seti:eslint',
+ '.eslintrc.cjs': 'seti:eslint',
+ '.eslintrc.yaml': 'seti:eslint',
+ '.eslintrc.yml': 'seti:eslint',
+ '.eslintrc.json': 'seti:eslint',
+ '.eslintignore': 'seti:eslint',
+ '.firebaserc': 'seti:firebase',
+ '.gitlab-ci.yml': 'seti:gitlab',
+ '.jshintrc': 'seti:javascript',
+ '.jscsrc': 'seti:javascript',
+ '.stylelintrc': 'seti:stylelint',
+ '.stylelintrc.json': 'seti:stylelint',
+ '.stylelintrc.yaml': 'seti:stylelint',
+ '.stylelintrc.yml': 'seti:stylelint',
+ '.stylelintrc.js': 'seti:stylelint',
+ '.stylelintignore': 'seti:stylelint',
+ '.direnv': 'seti:config',
+ '.env': 'seti:config',
+ '.static': 'seti:config',
+ '.editorconfig': 'seti:config',
+ '.slugignore': 'seti:config',
+ '.tmp': 'seti:clock',
+ '.htaccess': 'seti:config',
+ '.key': 'seti:lock',
+ '.cert': 'seti:lock',
+ '.cer': 'seti:lock',
+ '.crt': 'seti:lock',
+ '.pem': 'seti:lock',
+ '.DS_Store': 'seti:ignored',
+ },
+ partials: {
+ mix: 'seti:hex',
+ Gemfile: 'seti:ruby',
+ gemfile: 'seti:ruby',
+ dockerfile: 'seti:docker',
+ Dockerfile: 'seti:docker',
+ DOCKERFILE: 'seti:docker',
+ '.dockerignore': 'seti:docker',
+ 'docker-healthcheck': 'seti:docker',
+ 'docker-compose.yml': 'seti:docker',
+ 'docker-compose.yaml': 'seti:docker',
+ 'docker-compose.override.yml': 'seti:docker',
+ 'docker-compose.override.yaml': 'seti:docker',
+ GULPFILE: 'seti:gulp',
+ Gulpfile: 'seti:gulp',
+ gulpfile: 'seti:gulp',
+ 'gulpfile.js': 'seti:gulp',
+ LICENSE: 'seti:license',
+ LICENCE: 'seti:license',
+ 'LICENSE.txt': 'seti:license',
+ 'LICENCE.txt': 'seti:license',
+ 'LICENSE.md': 'seti:license',
+ 'LICENCE.md': 'seti:license',
+ COPYING: 'seti:license',
+ 'COPYING.txt': 'seti:license',
+ 'COPYING.md': 'seti:license',
+ COMPILING: 'seti:license',
+ 'COMPILING.txt': 'seti:license',
+ 'COMPILING.md': 'seti:license',
+ CONTRIBUTING: 'seti:license',
+ 'CONTRIBUTING.txt': 'seti:license',
+ 'CONTRIBUTING.md': 'seti:license',
+ MAKEFILE: 'seti:makefile',
+ Makefile: 'seti:makefile',
+ makefile: 'seti:makefile',
+ QMAKEFILE: 'seti:makefile',
+ QMakefile: 'seti:makefile',
+ qmakefile: 'seti:makefile',
+ OMAKEFILE: 'seti:makefile',
+ OMakefile: 'seti:makefile',
+ omakefile: 'seti:makefile',
+ 'CMAKELISTS.TXT': 'seti:makefile',
+ 'CMAKELISTS.txt': 'seti:makefile',
+ 'CMakeLists.txt': 'seti:makefile',
+ 'cmakelists.txt': 'seti:makefile',
+ Procfile: 'seti:heroku',
+ TODO: 'seti:todo',
+ 'TODO.txt': 'seti:todo',
+ 'TODO.md': 'seti:todo',
+ },
+};
+
+export const FileIcons = {
+ 'seti:folder':
+ '
',
+ 'seti:bsl':
+ '
',
+ 'seti:mdo':
+ '
',
+ 'seti:salesforce':
+ '
',
+ 'seti:asm':
+ '
',
+ 'seti:bicep':
+ '
',
+ 'seti:bazel':
+ '
',
+ 'seti:c':
+ '
',
+ 'seti:c-sharp':
+ '
',
+ 'seti:html':
+ '
',
+ 'seti:cpp':
+ '
',
+ 'seti:clojure':
+ '
',
+ 'seti:coldfusion':
+ '
',
+ 'seti:config':
+ '
',
+ 'seti:crystal':
+ '
',
+ 'seti:crystal_embedded':
+ '
',
+ 'seti:json':
+ '
',
+ 'seti:css':
+ '
',
+ 'seti:csv':
+ '
',
+ 'seti:xls':
+ '
',
+ 'seti:cu':
+ '
',
+ 'seti:cake':
+ '
',
+ 'seti:cake_php':
+ '
',
+ 'seti:d':
+ '
',
+ 'seti:word':
+ '
',
+ 'seti:elixir':
+ '
',
+ 'seti:elixir_script':
+ '
',
+ 'seti:hex':
+ '
',
+ 'seti:elm':
+ '
',
+ 'seti:favicon':
+ '
',
+ 'seti:f-sharp':
+ '
',
+ 'seti:git':
+ '
',
+ 'seti:go':
+ '
',
+ 'seti:godot':
+ '
',
+ 'seti:gradle':
+ '
',
+ 'seti:grails':
+ '
',
+ 'seti:graphql':
+ '
',
+ 'seti:hacklang':
+ '
',
+ 'seti:haml':
+ '
',
+ 'seti:mustache':
+ '
',
+ 'seti:haskell':
+ '
',
+ 'seti:haxe':
+ '
',
+ 'seti:jade':
+ '
',
+ 'seti:java':
+ '
',
+ 'seti:javascript':
+ '
',
+ 'seti:jinja':
+ '
',
+ 'seti:julia':
+ '
',
+ 'seti:karma':
+ '
',
+ 'seti:kotlin':
+ '
',
+ 'seti:dart':
+ '
',
+ 'seti:liquid':
+ '
',
+ 'seti:livescript':
+ '
',
+ 'seti:lua':
+ '
',
+ 'seti:markdown':
+ '
',
+ 'seti:argdown':
+ '
',
+ 'seti:info':
+ '
',
+ 'seti:clock':
+ '
',
+ 'seti:maven':
+ '
',
+ 'seti:nim':
+ '
',
+ 'seti:github':
+ '
',
+ 'seti:notebook':
+ '
',
+ 'seti:nunjucks':
+ '
',
+ 'seti:npm':
+ '
',
+ 'seti:ocaml':
+ '
',
+ 'seti:odata':
+ '
',
+ 'seti:perl':
+ '
',
+ 'seti:php':
+ '
',
+ 'seti:pipeline':
+ '
',
+ 'seti:pddl':
+ '
',
+ 'seti:plan':
+ '
',
+ 'seti:happenings':
+ '
',
+ 'seti:powershell':
+ '
',
+ 'seti:prisma':
+ '
',
+ 'seti:pug':
+ '
',
+ 'seti:puppet':
+ '
',
+ 'seti:purescript':
+ '
',
+ 'seti:python':
+ '
',
+ 'seti:react':
+ '
',
+ 'seti:rescript':
+ '
',
+ 'seti:R':
+ '
',
+ 'seti:ruby':
+ '
',
+ 'seti:rust':
+ '
',
+ 'seti:sass':
+ '
',
+ 'seti:spring':
+ '
',
+ 'seti:slim':
+ '
',
+ 'seti:smarty':
+ '
',
+ 'seti:sbt':
+ '
',
+ 'seti:scala':
+ '
',
+ 'seti:ethereum':
+ '
',
+ 'seti:stylus':
+ '
',
+ 'seti:svelte':
+ '
',
+ 'seti:swift':
+ '
',
+ 'seti:db':
+ '
',
+ 'seti:terraform':
+ '
',
+ 'seti:tex':
+ '
',
+ 'seti:default':
+ '
',
+ 'seti:twig':
+ '
',
+ 'seti:typescript':
+ '
',
+ 'seti:tsconfig':
+ '
',
+ 'seti:vala':
+ '
',
+ 'seti:vite':
+ '
',
+ 'seti:vue':
+ '
',
+ 'seti:wasm':
+ '
',
+ 'seti:wat':
+ '
',
+ 'seti:xml':
+ '
',
+ 'seti:yml':
+ '
',
+ 'seti:prolog':
+ '
',
+ 'seti:zig':
+ '
',
+ 'seti:zip':
+ '
',
+ 'seti:wgt':
+ '
',
+ 'seti:illustrator':
+ '
',
+ 'seti:photoshop':
+ '
',
+ 'seti:pdf':
+ '
',
+ 'seti:font':
+ '
',
+ 'seti:image':
+ '
',
+ 'seti:svg':
+ '
',
+ 'seti:sublime':
+ '
',
+ 'seti:code-search':
+ '
',
+ 'seti:shell':
+ '
',
+ 'seti:video':
+ '
',
+ 'seti:audio':
+ '
',
+ 'seti:windows':
+ '
',
+ 'seti:jenkins':
+ '
',
+ 'seti:babel':
+ '
',
+ 'seti:bower':
+ '
',
+ 'seti:docker':
+ '
',
+ 'seti:code-climate':
+ '
',
+ 'seti:eslint':
+ '
',
+ 'seti:firebase':
+ '
',
+ 'seti:firefox':
+ '
',
+ 'seti:gitlab':
+ '
',
+ 'seti:grunt':
+ '
',
+ 'seti:gulp':
+ '
',
+ 'seti:ionic':
+ '
',
+ 'seti:platformio':
+ '
',
+ 'seti:rollup':
+ '
',
+ 'seti:stylelint':
+ '
',
+ 'seti:yarn':
+ '
',
+ 'seti:webpack':
+ '
',
+ 'seti:lock':
+ '
',
+ 'seti:license':
+ '
',
+ 'seti:makefile':
+ '
',
+ 'seti:heroku':
+ '
',
+ 'seti:todo':
+ '
',
+ 'seti:ignored':
+ '
',
+};
+
+const folderIcon = makeSVGIcon(FileIcons['seti:folder']);
+const defaultFileIcon = makeSVGIcon(FileIcons['seti:default']);
+
+export function fileTree() {
+ return (tree: Element, _file: any) => {
+ validateFileTree(tree);
+
+ visit(tree, 'element', (node) => {
+ // Strip nodes that only contain newlines.
+ node.children = node.children.filter(
+ (child) => child.type === 'comment' || child.type !== 'text' || !/^\n+$/.test(child.value)
+ );
+
+ // Skip over non-list items.
+ if (node.tagName !== 'li') return CONTINUE;
+
+ const [firstChild, ...otherChildren] = node.children;
+
+ // Keep track of comments associated with the current file or directory.
+ const comment: Child[] = [];
+
+ // Extract text comment that follows the file name, e.g. `README.md This is a comment`
+ if (firstChild?.type === 'text') {
+ const [filename, ...fragments] = firstChild.value.split(' ');
+ firstChild.value = filename || '';
+ const textComment = fragments.join(' ').trim();
+ if (textComment.length > 0) {
+ comment.push(fragments.join(' '));
+ }
+ }
+
+ // Comments may not always be entirely part of the first child text node,
+ // e.g. `README.md This is an __important__ comment` where the `__important__` and `comment`
+ // nodes would also be children of the list item node.
+ const subTreeIndex = otherChildren.findIndex(
+ (child) => child.type === 'element' && child.tagName === 'ul'
+ );
+ const commentNodes =
+ subTreeIndex > -1 ? otherChildren.slice(0, subTreeIndex) : [...otherChildren];
+ otherChildren.splice(0, subTreeIndex > -1 ? subTreeIndex : otherChildren.length);
+ comment.push(...commentNodes);
+
+ const firstChildTextContent = firstChild ? toString(firstChild) : '';
+
+ // Decide a node is a directory if it ends in a `/` or contains another list.
+ const isDirectory =
+ /\/\s*$/.test(firstChildTextContent) ||
+ otherChildren.some((child) => child.type === 'element' && child.tagName === 'ul');
+ // A placeholder is a node that only contains 3 dots or an ellipsis.
+ const isPlaceholder = /^\s*(\.{3}|…)\s*$/.test(firstChildTextContent);
+ // A node is highlighted if its first child is bold text, e.g. `**README.md**`.
+ const isHighlighted = firstChild?.type === 'element' && firstChild.tagName === 'strong';
+
+ // Create an icon for the file or directory (placeholder do not have icons).
+ const icon = h('span', isDirectory ? folderIcon : getFileIcon(firstChildTextContent));
+
+ // Add classes and data attributes to the list item node.
+ node.properties.class = isDirectory ? 'directory' : 'file';
+ if (isPlaceholder) node.properties.class += ' empty';
+
+ // Create the tree entry node that contains the icon, file name and comment which will end up
+ // as the list item’s children.
+ const treeEntryChildren: Child[] = [
+ h('span', { class: isHighlighted ? 'highlight' : '' }, [
+ isPlaceholder ? null : icon,
+ firstChild,
+ ]),
+ ];
+
+ if (comment.length > 0) {
+ treeEntryChildren.push({ type: 'text', value: ' ' }, h('span', { class: 'comment' }, ...comment));
+ }
+
+ const treeEntry = h('span', { class: 'tree-entry' }, ...treeEntryChildren);
+
+ if (isDirectory) {
+ const hasContents = otherChildren.length > 0;
+
+ node.children = [
+ h('details', { open: hasContents }, [
+ h('summary', treeEntry),
+ ...(hasContents ? otherChildren : [h('ul', h('li', '…'))]),
+ ]),
+ ];
+
+ // Continue down the tree.
+ return CONTINUE;
+ }
+
+ node.children = [treeEntry, ...otherChildren];
+
+ // Files can’t contain further files or directories, so skip iterating children.
+ return SKIP;
+ });
+ };
+}
+
+/** Make a node containing an SVG icon from the passed HTML string. */
+function makeSVGIcon(svgString: string) {
+ return s(
+ 'svg',
+ {
+ width: 16,
+ height: 16,
+ class: 'tree-icon',
+ 'aria-hidden': 'true',
+ viewBox: '0 0 24 24',
+ },
+ fromHtml(svgString, { fragment: true })
+ );
+}
+
+/** Return the icon for a file based on its file name. */
+function getFileIcon(fileName: string) {
+ const name = getFileIconName(fileName);
+ if (!name) return defaultFileIcon;
+
+ if (name in FileIcons) {
+ return makeSVGIcon(FileIcons[(name as keyof typeof FileIcons)]);
+ }
+
+ return defaultFileIcon;
+}
+
+/** Return the icon name for a file based on its file name. */
+function getFileIconName(fileName: string) {
+ let icon: string | undefined = definitions.files[fileName];
+ if (icon) return icon;
+ icon = getFileIconTypeFromExtension(fileName);
+ if (icon) return icon;
+ for (const [partial, partialIcon] of Object.entries(definitions.partials)) {
+ if (fileName.includes(partial)) return partialIcon;
+ }
+ return icon;
+}
+
+/**
+ * Get an icon from a file name based on its extension.
+ * Note that an extension in Seti is everything after a dot, so `README.md` would be `.md` and
+ * `name.with.dots` will try to look for an icon for `.with.dots` and then `.dots` if the first one
+ * is not found.
+ */
+function getFileIconTypeFromExtension(fileName: string) {
+ const firstDotIndex = fileName.indexOf('.');
+ if (firstDotIndex === -1) return;
+ let extension = fileName.slice(firstDotIndex);
+ while (extension !== '') {
+ const icon = definitions.extensions[extension];
+ if (icon) return icon;
+ const nextDotIndex = extension.indexOf('.', 1);
+ if (nextDotIndex === -1) return;
+ extension = extension.slice(nextDotIndex);
+ }
+ return;
+}
+
+/** Validate that the user provided HTML for a file tree is valid. */
+function validateFileTree(tree: Element) {
+ const rootElements = tree.children.filter((node) => node.type === 'element');
+ const [rootElement] = rootElements;
+
+ if (rootElements.length === 0) {
+ throwFileTreeValidationError(
+ 'The `
` component expects its content to be a single unordered list but found no child elements.'
+ );
+ }
+
+ if (rootElements.length !== 1) {
+ throwFileTreeValidationError(
+ `The \`\` component expects its content to be a single unordered list but found multiple child elements: ${rootElements
+ .map((element) => `\`<${element.tagName}>\``)
+ .join(' - ')}.`
+ );
+ }
+
+ if (!rootElement || rootElement.tagName !== 'ul') {
+ throwFileTreeValidationError(
+ `The \`\` component expects its content to be an unordered list but found the following element: \`<${rootElement?.tagName}>\`.`
+ );
+ }
+
+ const listItemElement = select('li', rootElement);
+
+ if (!listItemElement) {
+ throwFileTreeValidationError(
+ 'The `` component expects its content to be an unordered list with at least one list item.'
+ );
+ }
+}
+/** Throw a validation error for a file tree linking to the documentation. */
+function throwFileTreeValidationError(message: string): never {
+ throw new AstroError(
+ message,
+ 'To learn more about the `` component, see https://starlight.astro.build/components/file-tree/'
+ );
+}
+
+export interface Definitions {
+ files: Record;
+ extensions: Record;
+ partials: Record;
+}
diff --git a/src/config.ts b/src/config.ts
index d9fb0b0..8ca6a1d 100644
--- a/src/config.ts
+++ b/src/config.ts
@@ -27,4 +27,31 @@ async fn main(peripherals: Peripherals) {
_ = my_motor.set_voltage(10.0);
}`,
},
-];
\ No newline at end of file
+];
+
+export const DOCS_SIDEBAR = {
+ "01. Getting Started": [
+ "index",
+ "prerequisites",
+ "program-structure",
+ "building-uploading",
+ "using-the-terminal",
+ "competition",
+ ],
+ "02. Devices": [
+ "peripherals",
+ "motor",
+ "controller",
+ "inertial-sensor",
+ "rotation-sensor",
+ "distance-sensor",
+ "optical-sensor",
+ ],
+ "03. Multitasking": [
+ "async-introduction",
+ ],
+ "04. Specific Topics": [
+ "abort",
+ "features",
+ ]
+};
\ No newline at end of file
diff --git a/src/content/blog/0.8.0-migration-guide.md b/src/content/blog/0.8.0-migration-guide.md
new file mode 100644
index 0000000..96aa32a
--- /dev/null
+++ b/src/content/blog/0.8.0-migration-guide.md
@@ -0,0 +1,268 @@
+---
+title: vexide 0.8.0 Migration Guide
+description: Migrate to the new vexide 0.8.0 runtime.
+tags: ["writeups"]
+author: lewisfm
+date: 2025-09-04
+---
+
+vexide v0.8 is a new version of the runtime including improvements such as: support for the Rust Standard Library, new async runtime APIs, support for encoders with custom resolutions, the option to use the official VEX SDK, and various bug fixes. While we have aimed to minimize breaking changes, you will need to update your existing projects to make them compatible with this new release.
+
+# Automatic Upgrade Tool
+
+> [!IMPORTANT]
+>
+> **Well, this doesn't exist yet. It would be pretty convenient though.**
+
+If you'd like to upgrade a project from v0.7 to v0.8, you can use our automatic upgrade tool to do much of the hard part for you:
+
+```sh
+cargo v5 upgrade
+```
+
+This will handle updating vexide, enabling the Rust Standard Library, and updating your project's Cargo configuration. However, it won't handle any changes to vexide's API, so if you encounter any build errors after the update, consult the [API Changes](#api-changes) section.
+
+You'll need to have the latest version of cargo-v5 installed to use this command, so make sure to update it beforehand. **We also strongly suggest testing the upgrade on a separate branch**, then merging it once you've reviewed the changes to your code and verified that they work.
+
+Even if you run the upgrade tool with no complications, we still recommend reading through all of the [Breaking Changes](#breaking-changes-guide) included in v0.8 to get a good idea of what's changed and make sure the upgrade tool didn't miss anything.
+
+# Manual Upgrade Guide
+
+Here's a comprehensive guide on upgrading to vexide v0.8 from v0.7. Apart from the [API Changes](#api-changes), most of these differences can be handled by our [Automatic Upgrade Tool](#automatic-upgrade-tool).
+
+If you'd rather start a new project than upgrade your current one, check out our updated [template project](https://github.com/vexide/vexide-template/tree/vexide-0.8.0). (Clicking "Use this template" will use the stable version, but you can still download the zip file or clone the pre-release branch.)
+
+## Update cargo-v5
+
+Install the pre-release of cargo-v5.
+
+```sh
+cargo install --git "https://github.com/vexide/cargo-v5.git" --branch upstreamed-target
+```
+
+## Update Rust
+
+Update your `rust-toolchain.toml` file to install a newer version of Rust.
+
+```toml title="rust-toolchain.toml"
+[toolchain]
+# @diff +
+channel = "nightly-2025-09-26"
+# @diff -
+channel = "nightly"
+components = ["rust-src"]
+```
+
+## Update vexide
+
+To use vexide v0.8, you'll need to update it in your dependencies table, then choose which SDKs you'd like to enable. Use the configuration below to keep your project's existing behavior.
+
+```toml title="Cargo.toml"
+# @fold start
+[package]
+name = "my-vexide-project"
+version = "0.1.0"
+edition = "2024"
+
+[package.metadata.v5]
+upload-strategy = "differential"
+slot = 1
+icon = "cool-x"
+compress = true
+
+# @fold end
+[dependencies]
+# @diff -
+vexide = "0.7.0"
+
+# @diff + start
+[dependencies.vexide]
+version = "0.8.0-alpha.2"
+features = ["full", "vex-sdk-jumptable", "vex-sdk-mock"]
+# @diff + end
+```
+
+> [!TIP]
+> If you're updating a library that uses vexide, don't enable `full`
+> or any of the `vex-sdk-*` features. ();
+
+ // @diff +
+ vexide::startup::startup();
+ // @diff +
+ vexide::startup::banner::print();
+}
+```
diff --git a/src/content/blog/fall-update-24.md b/src/content/blog/fall-update-24.mdx
similarity index 98%
rename from src/content/blog/fall-update-24.md
rename to src/content/blog/fall-update-24.mdx
index 1e35c22..8e1133b 100644
--- a/src/content/blog/fall-update-24.md
+++ b/src/content/blog/fall-update-24.mdx
@@ -1,7 +1,10 @@
---
title: "Fall Updates: vexide 0.4.0, cargo-v5 0.8.0, Simulator, Docs, and more!"
description: Important project updates for Fall 2024!
-author: tropicaaal
+author: {
+ name: "Tropical",
+ github: "tropicaaal",
+}
tags: ["news"]
date: 2024-10-05
thumbnail: {
@@ -10,6 +13,8 @@ thumbnail: {
}
---
+import SplitCodeblock from "components/SplitCodeblock.astro";
+
It's that time of the year — and by "that time", I mean... early October! Hey, fall is a nice season.
We've got some important updates to share with you regarding the vexide project, so let's recap everything that's been worked on since our [summer update](/blog/posts/summer-update-24/).
@@ -51,8 +56,7 @@ We've got a fancy new startup banner inspired by `neofetch`. It looks like this:
This makes better use of space in the terminal, and prints some useful information along with it for debugging. It also supports a bunch of custom themes!
-
-
+
```rs
// @fold start
#![no_std]
@@ -76,8 +80,7 @@ async fn main(_peripherals: Peripherals) {}
[1;38;2;115;207;244m +%%%*: .+###%#[0m ├─[1;33m🔋 Battery:[0m 100%
[1;38;2;115;207;244m .%:[0m ╰─[1;33m⌚ Uptime:[0m 60.18ms
```
-
-
+
## Math Got Even Faster
@@ -167,7 +170,7 @@ note: Use a symbolizer to convert stack frames to human-readable function names.
This is a useful debugging feature that gives you the memory location of each function call leading up to the panic. You can retrieve the human-readable function names by putting these addresses through a symbolizer like [`llvm-symbolizer`](https://llvm.org/docs/CommandGuide/llvm-symbolizer.html):
-
+
```sh
llvm-symbolizer --obj ./target/armv7a-vex-v5/debug/examples/basic -p 0x380978b 0x382effb 0x382f1ef 0x382f17b 0x38022eb 0x380517f 0x3803377 0x381694b 0x381736f 0x3806773 0x3808b87 0x38022ab
@@ -189,7 +192,7 @@ vexide_async::block_on::h89430167eae07d09 at /home/tropical/Documents/GitHub/vex
_start at /home/tropical/Documents/GitHub/vexide/packages/vexide/examples/basic.rs:7:1
```
-
+
> [!NOTE]
> This was made possible by compiling a custom version of [`libunwind`](https://github.com/llvm/llvm-project/tree/main/libunwind) for the V5 brain, then [writing our own bindings to the library for retrieving backtrace context](https://github.com/vexide/vex-libunwind). Thanks to [Lewis](https://github.com/doinkythederp/) for his work on this!
@@ -198,7 +201,7 @@ _start at /home/tropical/Documents/GitHub/vexide/packages/vexide/examples/basic.
Since vexide's release, we had this stupid line of code in our linkerscript (a file that lays out memory regions for your program):
-```linkerscript
+```
/*
It's currently unclear why subtracting anything is necessary, but it fixes memory permission errors.
0x100 is an arbitrary number that works.
@@ -250,7 +253,7 @@ Work has been started on a GUI interface for the QEMU simulator. It's written us
-
+
diff --git a/src/content/blog/fall-update-25.mdx b/src/content/blog/fall-update-25.mdx
new file mode 100644
index 0000000..dfe08f4
--- /dev/null
+++ b/src/content/blog/fall-update-25.mdx
@@ -0,0 +1,384 @@
+---
+title: "Fall Updates: Standard Library Support with vexide 0.8.0!"
+description: "vexide 0.8.0 brings support for the Rust Standard Library, an improved development experience, and various API improvements."
+author: {
+ name: "Tropical",
+ github: "tropicaaal",
+}
+tags: ["news"]
+date: 2025-09-30
+thumbnail: {
+ url: "/images/thumbnails/twilight.png",
+ alt: "vexide logo drawn over a night sky"
+}
+---
+
+import SplitCodeblock from "components/SplitCodeblock.astro";
+
+Hi everyone, we're excited announce by far the largest update to vexide yet. This release introduces support for Rust's Standard Library, unit testing robot code, running programs without a robot, improved error reporting, and much more!
+
+> [!TIP]
+> vexide is a Rust library for programming VEX robots, empowering you to write safe and efficient code for your robot in the Rust programming language. [Learn more.](/docs/#what-is-vexide)
+
+# Rust Standard Library Support
+
+vexide programs have historically required that Rust's Standard Library (the `std` crate) be disabled. This forces vexide users to use the stripped down `core` and `alloc` libraries instead, which significantly limits the libraries on [crates.io](https://crates.io/) that projects can use. It also means we can't use some nice features of the standard library like `std::io`.
+
+```rs
+// @highlight start
+#![no_std]
+#![no_main]
+// @highlight end
+// ^<<<
+// [no standard library :(]
+
+use vexide::prelude::*;
+
+async fn main(_peripherals: Peripherals) {}
+```
+
+We do this because the `std` crate depends on features provided by an operating system, and nobody had bothered to write a port of the standard library for VEXos in the Rust compiler ...until now!
+
+
+
+Over the last year we've been working on upstreaming support for VEX brains as an official compilation target and standard platform *in the Rust language itself*. This means that you can now use the `std` crate and compile to a V5 brain using the [`armv7a-vex-v5` target](https://doc.rust-lang.org/nightly/rustc/platform-support/armv7a-vex-v5.html) in Rust!
+
+```rs title="main.rs"
+// This runs on a brain now.
+fn main() {
+ println!("Hello, World!");
+}
+```
+
+This unlocks a huge portion of the Rust ecosystem. Most libraries that require `std` now “just work”. You can use the `std::fs` API to write to the brain's SDCard and use the *real* `println!` macro to print to the terminal. I've even managed to run [Tokio](https://tokio.rs/) on a V5 brain!
+
+
+
+
+
+
+Please don't try this at home.
+
+
+
+```sh
+cargo v5 run --release
+```
+
+```ansi
+ Finished `release` profile [optimized] target(s) in 0.19s
+ [1;92mObjcopy[0m /home/tropical/Documents/GitHub/vexide/target/armv7a-vex-v5/release/examples/basic.bin
+ [1;92mRunning[0m `slot_1.bin`
+go go gadget null pointer dereference
+
+Data Abort exception at 0x3800ed0:
+Permission fault (MMU) while writing to 0x0
+
+registers at time of fault:
+ r0: 0x0
+ r1: 0x0
+ r2: 0x0
+ r3: 0x0
+ r4: 0x1
+ r5: 0x0
+ r6: 0x0
+ r7: 0x7a00024
+ r8: 0x7a00034
+ r9: 0x7a0001c
+r10: 0x380fba8
+r11: 0x132
+r12: 0x3692594
+ sp: 0x79ffe60
+ lr: 0x3800e8c
+ pc: 0x3800ed0
+
+stack backtrace:
+ 0: 0x3800ecf
+ 1: 0x3801a83
+ 2: 0x38003f7
+
+help: this CPU fault indicates the misuse of unsafe code.
+ Use a symbolizer tool to determine the location of the crash.
+ (e.g. llvm-symbolizer -e ./target/armv7a-vex-v5/release/program_name 0x3800ed0)
+```
+
+
+
+This new error reporting system (which is enabled by default with the `abort-handler` feature flag) provides more helpful information for debugging and finding the location of these types of crashes, including:
+
+- The full cause of the CPU exception (including the type of operation that caused the fault).
+- A stack backtrace leading up to the function causing the exception. The addresses in this trace can be passed to a symbolizer program like [`llvm-symbolizer`](https://llvm.org/docs/CommandGuide/llvm-symbolizer.html) to find the exact line of code causing the abort.
+- For undefined instruction exceptions, the invalid instruction that caused the abort.
+- The CPU's registers at the time of the fault.
+- The ability to print this data to the terminal and re-print it if your terminal wasn't open when the program crashed.
+
+> [!TIP]
+> As a reminder, vexide is designed to [explicitly prevent these kinds of errors from happening](http://localhost:4321/docs/#safety-predictability-and-fault-tolerance) and it should ideally be *impossible* to trigger these using only safe Rust code. That being said, if or when you do encounter them, we want to make the problem as easy to diagnose as possible.
+
+# Other Changes in `vexide` 0.8.0
+
+## Custom Encoder Support
+
+It's fairly common for VEXU teams to use off-the-shelf shaft encoders rather than buying sensors sold by VEX. vexide currently supports VEX's old [Optical Shaft Encoders](https://www.vexrobotics.com/276-2156.html) through the [`AdiEncoder` API](https://docs.rs/vexide/latest/vexide/devices/adi/struct.AdiEncoder.html), and while this is *sort of* compatible with custom hardware already, commonly used sensors like the [AMT102-V](https://www.sameskydevices.com/product/motion-and-control/rotary-encoders/incremental/modular/amt102-v) often have much higher resolution than VEX's optical encoders (which have a resolution of 360 ticks/rev). In the past, you'd have to multiply the output of `AdiEncoder` by a constant to get a usable angle reading, which was rather annoying.
+
+In `vexide` 0.8.0, we now provide support for encoders with custom resolutions. `AdiEncoder` now takes a const-generic argument for the number of encoder ticks in a full revolution. The position reading will be automatically scaled appropriately for the encoder's TPR.
+
+For example, you can read from an encoder with a resolution of 8192 ticks/rev like this:
+
+```rs
+use vexide::prelude::*;
+
+const ENCODER_TPR: u32 = 8192;
+
+#[vexide::main]
+async fn main(peripherals: Peripherals) {
+ let enc = AdiEncoder::::new(
+ peripherals.adi_a,
+ peripherals.adi_b
+ );
+
+ println!("Encoder position: {:?}", enc.position().unwrap().as_degrees());
+}
+```
+
+We also provide an `AdiOpticalEncoder` type alias for if you're using VEX's optical encoder. This simply resolves to `AdiEncoder<360>`, and should behave identically to the previous `AdiEncoder` API in vexide 0.7.0 and below.
+
+```rs
+use vexide::prelude::*;
+
+#[vexide::main]
+async fn main(peripherals: Peripherals) {
+ let enc = AdiOpticalEncoder::new(
+ peripherals.adi_a,
+ peripherals.adi_b
+ );
+
+ println!("Encoder position: {:?}", enc.position().unwrap().as_degrees());
+}
+```
+
+## Task-local Storage (TLS)
+
+vexide now supports the ability to create **async task-local static data**. That's a lot of of word salad, so let's look at what this practically means.
+
+You can define a task-local static variable by wrapping it in the new `task_local!` macro. Let's make a counter:
+
+```rs
+use std::cell::Cell;
+
+vexide::task::task_local! {
+ static COUNT: Cell = Cell::new(1);
+}
+```
+
+This looks a lot like a normal static, but when we spawn an [async task](http://localhost:4321/docs/async-introduction/), each task will get its own unique version of `COUNT` starting at `1`. In other words, value of `COUNT` is *local* to each task accessing it.
+
+
+
+```rs
+// @fold start
+use vexide::prelude::*;
+use std::{cell::Cell, std::time::Duration};
+
+vexide::task::task_local! {
+ static COUNT: Cell = Cell::new(1);
+}
+
+//@fold end
+let task = spawn(async {
+ loop {
+ println!("Spawned task count: {}", COUNT.get());
+ COUNT.set(COUNT.get() + 1);
+
+ sleep(Duration::from_millis(100)).await;
+ }
+});
+
+loop {
+ println!("Main task count: {}", COUNT.get());
+ COUNT.set(COUNT.get() + 1);
+
+ sleep(Duration::from_millis(100)).await;
+}
+```
+
+```
+Main task count: 1
+Spawned task count: 1
+Main task count: 2
+Spawned task count: 2
+Main task count: 3
+Spawned task count: 3
+Main task count: 4
+Spawned task count: 4
+Main task count: 5
+Spawned task count: 5
+Main task count: 6
+Spawned task count: 6
+```
+
+
+
+> [!TIP]
+> Task-local `static`s have a few advantages over regular global `static`s. Because each task gets its own isolated instance, they don't require any form of synchronization (no need for a `Mutex`). They can also safely store types that wouldn’t be allowed in global statics, such as types that don't implement `Sync`.
+
+## Low-level User Program Information
+
+
+We've added new functions for retrieving some niche information about the current user program. The new `code_signature` and `linked_file` functions in `vexide::program` allow you to read the currently running program's code signature and file link address:
+
+```rs
+let code_sig = vexide::program::code_signature();
+let linked_file_ptr = vexide::program::linked_file();
+
+println!("Program owner: {:?}", code_sig.owner());
+println!("Link address: {:#x}", linked_file_ptr as usize);
+```
+
+These functions aren't something that you should realistically need to use or care about in most cases, but are useful to have for low-level development.
+
+
+
+# `cargo-v5` 0.12.0
+
+# New Contributors
+
+> [!THANKS]
+> vexide is a community project maintained for free by open-source contributors. We'd like to thank the following new contributors to the project:
+
+- [fibonacci61](http://github.com/fibonacci61) wrote an initial implementation of our new async Task-local Storage system in vexide's async runtime.
+- [slipperking](http://github.com/slipperking) fixed some bugs in vexide's AI Vision API and helped with documentation.
+
+Thanks again for your contributions!
+
+
-
-
-```ansi
-windows build for platform vexv5
-"CXX src/main.cpp"
-"LINK build/vexcode-test.elf"
- text data bss dec hex filename
- 1256 1076 1062948 1065280 104140 build/vexcode-test.elf
-
-Finished
-```
-
-
-
-
-
-
-Our build output
-
-
-
-
+
-
+
Using the brain for its intended purpose — email.
-
+
@@ -72,7 +77,7 @@ Along with the new tooling improvements, we've also released vexide version 0.3.
We've revamped the old `CompetitionRobot` trait for this version. It's now called `Compete` and should have less boilerplate.
-
+
```rs
//! 0.2.0
@@ -100,7 +105,7 @@ impl Compete for Robot {
}
```
-
+
An important change here is that competition functions are now *infallible*, meaning they can no longer return an error type. This was previously allowed for the convenience of using Rust's `?` operator to return early if an error occurs, but returning early in the competition lifecycle will effectively just crash your program, which isn't good practice at all.
@@ -108,7 +113,7 @@ An important change here is that competition functions are now *infallible*, mea
Embedded Rust is a little weird. If you're coming from a typical Rust project with the standard library, you may find many things just *missing* in a `no_std` environment. One of those things is support for math on floating-point numbers.
-
+
```rs
#![no_std]
@@ -131,7 +136,7 @@ fn main() {
[0m [0m[0m[1m[38;5;12m| [0m[0m [0m[0m[1m[38;5;9mhelp: there is a method with a similar name: `min`[0m
```
-
+
This is because Rust's standard library uses a combination of your platform's `libm` library and certain LLVM intrinisics that just aren't available for our target. There's active proposals being made to [fix this](https://github.com/rust-lang/rfcs/issues/2505) in upstream Rust, but we aren't quite there yet.
diff --git a/src/content/blog/thanksgiving-update-24.md b/src/content/blog/thanksgiving-update-24.md
index 0f55e62..eaa4a89 100644
--- a/src/content/blog/thanksgiving-update-24.md
+++ b/src/content/blog/thanksgiving-update-24.md
@@ -1,7 +1,10 @@
---
title: "Thanksgiving Updates: vexide 0.5.0, AI Vision, Java/Kotlin on V5, evian"
description: Happy thanksgiving everyone!
-author: tropicaaal
+author: {
+ name: "Tropical",
+ github: "tropicaaal",
+}
tags: ["news"]
date: 2024-11-28
thumbnail: {
diff --git a/src/content/blog/vexide-release.md b/src/content/blog/vexide-release.md
index 82b9f7f..10952bf 100644
--- a/src/content/blog/vexide-release.md
+++ b/src/content/blog/vexide-release.md
@@ -1,7 +1,10 @@
---
title: vexide has been released to crates.io!
description: All about the first version of vexide
-author: gavin-niederman
+author: {
+ name: "Tropical",
+ github: "tropix126",
+}
thumbnail: {
url: "/images/thumbnails/flower.png",
alt: "Thumbnail Image"
diff --git a/src/content/blog/winter-update-25.md b/src/content/blog/winter-update-25.md
index 6a4e94e..2f81fd9 100644
--- a/src/content/blog/winter-update-25.md
+++ b/src/content/blog/winter-update-25.md
@@ -1,7 +1,10 @@
---
title: "Winter Updates: Instant wireless uploads on vexide 0.6.0 & cargo-v5"
-description: vexide update!!!!!!!!!! yippee!!!!
-author: tropicaaal
+description: vroom vroom
+author: {
+ name: "Tropical",
+ github: "tropicaaal",
+}
tags: ["news"]
date: 2025-01-26
thumbnail: {
diff --git a/src/content/config.ts b/src/content/config.ts
index 3d3e83f..c67b960 100644
--- a/src/content/config.ts
+++ b/src/content/config.ts
@@ -3,39 +3,41 @@ import { z, defineCollection } from "astro:content";
const blog = defineCollection({
type: 'content',
schema: z.object({
- title: z.string(),
- date: z.date(),
- description: z.string(),
- author: z.string(),
- thumbnail: z.object({
- url: z.string(),
- alt: z.string()
- }).optional(),
- tags: z.array(z.string()),
- draft: z.boolean().optional(),
+ title: z.string(),
+ date: z.date(),
+ description: z.string(),
+ author: z.object({
+ name: z.string().optional(),
+ github: z.string(),
+ }).or(z.string()),
+ thumbnail: z.object({
+ url: z.string(),
+ alt: z.string()
+ }).optional(),
+ tags: z.array(z.string()),
+ draft: z.boolean().optional(),
})
});
const docs = defineCollection({
type: 'content',
schema: z.object({
- title: z.string(),
- category: z.string(),
- page: z.number(),
+ title: z.string(),
+ links: z.record(z.string()).optional()
})
});
const releases = defineCollection({
- type: 'content',
- schema: z.object({
- title: z.string(),
- project: z.string(),
- date: z.date(),
- })
+ type: 'content',
+ schema: z.object({
+ title: z.string(),
+ project: z.string(),
+ date: z.date(),
+ })
});
export const collections = {
- docs,
- blog,
- releases,
+ docs,
+ blog,
+ releases,
};
diff --git a/src/content/docs/abort.mdx b/src/content/docs/abort.mdx
new file mode 100644
index 0000000..079f6c5
--- /dev/null
+++ b/src/content/docs/abort.mdx
@@ -0,0 +1,136 @@
+---
+title: Aborts and Panics
+---
+
+import SplitCodeblock from "components/SplitCodeblock.astro";
+
+
+
+vexide is designed to be *fault-tolerant*, meaning it should be difficult for code to unintentionally fail in unexpected ways. Sometimes, that doesn't go to plan and you need to find out why. This page will cover how to troubleshoot and fix unrecoverable failures in vexide programs.
+
+There are two forms of errors that will cause a program to crash — **panics** and **aborts** (also known as *exceptions*).
+
+# Panics
+
+A [panic](https://doc.rust-lang.org/book/ch09-01-unrecoverable-errors-with-panic.html) is an *intentional decision* made by the program to stop running due to some unrecoverable or unhandled error. Panics can occur for a variety of reasons, but typically happen when something goes wrong at the logic or runtime level. For example:
+
+- Accessing an out-of-bounds index in an array.
+- Unwrapping a `Result` or `Option` that contains an error or `None`.
+- Failing an internal assertion (e.g. `assert!(condition)`).
+- Violating the contract of a function with documented panic conditions.
+
+When a panic occurs, vexide halts the program and prints a detailed message describing what happened to the Brain's display and terminal.
+
+
+
+
+
+ A panic message is drawn to the screen along with a stack backtrace.
+
+
+```rs
+// @fold start
+use vexide::prelude::*;
+
+// @fold end
+#[vexide::main]
+async fn main(_peripherals: Peripherals) {
+// (err )
+ panic!();
+}
+```
+
+```ansi
+panicked at main.rs:5:5:
+explicit panic
+stack backtrace:
+ 0: 0x380832f
+ 1: 0x380041b
+ 2: 0x38064b7
+ 3: 0x3804983
+ 4: 0x3804913
+ 5: 0x38061e3
+ 6: 0x3803373
+ 7: 0x380351b
+ 8: 0x3800ed3
+ 9: 0x3800c1f
+ 10: 0x3800407
+note: Use a symbolizer to convert stack frames to human-readable function names.
+```
+
+
+In the example above, we are told that the panic originates from `main.rs:5:5`. This can be read as "main.rs, line 5, column 5". Looking at line 5 of `main.rs` shows us that there is indeed a `panic!()` invocation.
+
+```rs title="main.rs"
+use vexide::prelude::*;
+
+#[vexide::main]
+async fn main(_peripherals: Peripherals) {
+// (err )
+ panic!();
+// ^
+// [Panic occurred here.]<
+}
+```
+
+The message we are given is simply "explicit panic", which is the default message that Rust will use when invoking `panic!()` with no custom message. In practice, you will typically be given a more helpful message describing exactly what went wrong.
+
+# Aborts
+
+An **abort** (also called an *exception*) is a serious, unexpected failure that happens when the Brain's user processor experiences a hardware or system-level error. Aborts are often a sign of *undefined behavior* from `unsafe` code being misused (either from your code or from a library you're using).
+
+
+
+
+
+ An abort message is drawn to the screen along with a register dump and stack backtrace. This abort was caused by a null pointer dereference (hence the "writing to 0x0" message).
+
+
/` as a file with no extension. Replace `` with either `debug` or `release` depending on if your project was compiled in debug or release mode and `` with the name of your project.
+
+To use `llvm-symbolizer`, we give it our compiled code and the address of the abort. Let's say we aborted at address `0x123456678` in a project named `my-robot` compiled for `release` mode:
+
+
+
+```sh
+llvm-symbolizer -p -o ./target/release/my-project 0x12345678
+```
+
+```ansi
+src/main.rs:42:13
+my_crate::module::some_function
+```
+
+
+Running this should hopefully give you the file name, line number, and symbol name where the abort occurred.
\ No newline at end of file
diff --git a/src/content/docs/async-introduction.md b/src/content/docs/async-introduction.mdx
similarity index 97%
rename from src/content/docs/async-introduction.md
rename to src/content/docs/async-introduction.mdx
index 9101b73..c8eb0a9 100644
--- a/src/content/docs/async-introduction.md
+++ b/src/content/docs/async-introduction.mdx
@@ -1,9 +1,9 @@
---
title: Async Rust
-category: 03. Multitasking
-page: 12
---
+import SplitCodeblock from "components/SplitCodeblock.astro";
+
`async` is a feature of the Rust language that allows you to express when code *waits for things to happen*. By doing this, we write code that cooperates with other parts of our program to multitask, or do more than one thing concurrently.
VIDEO
@@ -66,9 +66,6 @@ Well, let's try treating it like a normal function and calling it.
```rs
// @fold start
-#![no_std]
-#![no_main]
-
use vexide::prelude::*;
// @fold end
@@ -91,9 +88,6 @@ In order to actually execute our `wow` function, we need to `await` it.
```rs
// @fold start
-#![no_std]
-#![no_main]
-
use vexide::prelude::*;
async fn wow() {
@@ -120,9 +114,6 @@ To demonstrate this behavior, we can store the return value (the "future") of ou
```rs
// @fold start
-#![no_std]
-#![no_main]
-
use vexide::prelude::*;
async fn wow() {
@@ -171,7 +162,7 @@ So far, we've just made a regular function `async` for seemingly no reason. Sinc
```rs
// @fold start
use vexide::prelude::*;
-use core::time::Duration;
+use std::time::Duration;
// @fold end
#[vexide::main]
@@ -220,12 +211,12 @@ async fn b() {
If we call and `await` these functions directly in `main` we would only ever run the first function since it loops forever.
-
+
```rs
// @fold start
use vexide::prelude::*;
-use core::time::Duration;
+use std::time::Duration;
async fn a() {
loop {
@@ -264,7 +255,7 @@ hello
hello
```
-
+
@@ -272,12 +263,12 @@ But we want to run these at the same time! To do this, let's make some *tasks* t
We can do this with vexide's `spawn` function. This will poll a future in a background task without forcing our `main` function to wait until it's complete. Rather than `await`ing `a` and `b`'s futures, we instead pass them to `spawn()` to run them in a task.
-
+
```rs
// @fold start
use vexide::prelude::*;
-use core::time::Duration;
+use std::time::Duration;
async fn a() {
loop {
@@ -324,7 +315,7 @@ hello
hello
```
-
+
@@ -332,7 +323,7 @@ It works! And notice how we don't `await` `a()` or `b()`, as `spawn` does that f
## `async` Blocks
-The *`async` block* is a syntax feature that allow us to concisely create a `Future` that can be awaited at a later time.
+The *`async` block* is a syntax feature that allows us to concisely create a `Future` that can be awaited at a later time.
```rs
// The code within this block will not run until we `await` it.
@@ -348,7 +339,7 @@ This is useful because it allows us to spawn tasks without needing entirely sepa
```rs
// @fold start
use vexide::prelude::*;
-use core::time::Duration;
+use std::time::Duration;
// @fold end
#[vexide::main]
@@ -380,7 +371,7 @@ This also let's us demonstrate a fact we discussed earlier.
Recall that `async fn`s are desugared into regular functions that return a `Future`. With that in mind, we can demonstrate that these two functions are the same:
-
+
```rs
async fn multiply(a: f64, b: f64) {
@@ -390,7 +381,7 @@ async fn multiply(a: f64, b: f64) {
```
```rs
-use core::future::Future;
+use std::future::Future;
fn multiply(a: f64, b: f64) -> impl Future {
async {
@@ -400,7 +391,7 @@ fn multiply(a: f64, b: f64) -> impl Future {
}
```
-
+
Above is an `async fn`, and below we have a regular function returning an `async` block (a struct implementing the `Future` trait).
diff --git a/src/content/docs/building-uploading.md b/src/content/docs/building-uploading.md
index f856280..821ea9e 100644
--- a/src/content/docs/building-uploading.md
+++ b/src/content/docs/building-uploading.md
@@ -1,7 +1,5 @@
---
title: Building & Uploading
-category: 01. Getting Started
-page: 4
---
# Uploading with `cargo v5`
@@ -24,7 +22,7 @@ cargo v5 upload --release
- {author} • {
+ {authorName} • {
new Date(date).toLocaleDateString("en-US", { timeZone: 'UTC' })
}
diff --git a/src/layouts/DocsLayout.astro b/src/layouts/DocsLayout.astro
index 01ec3f2..733c74e 100644
--- a/src/layouts/DocsLayout.astro
+++ b/src/layouts/DocsLayout.astro
@@ -5,450 +5,538 @@ import NavigationItem from "components/NavigationItem.astro";
import Button from "components/Button.svelte";
import DocsSearch from "components/DocsSearch.svelte";
import MarkdownStyles from "components/MarkdownStyles.astro";
-import { GITHUB_ORG_URL } from "config";
+import { GITHUB_ORG_URL, DOCS_SIDEBAR } from "config";
import BaseLayout from "./BaseLayout.astro";
-import { getCollection } from "astro:content";
-import { categorize } from "utils";
+import { getEntry } from "astro:content";
const { page: currentPage } = Astro.props;
-const pages = (await getCollection("docs")).sort(
- (a: any, b: any) => a.data.page - b.data.page,
-);
-const categories = categorize(pages, (page: any) => page.data.category);
+const allPages = Object.values(DOCS_SIDEBAR).flat();
+const currentCategory = Object.entries(DOCS_SIDEBAR).find(([, ids]) => ids.includes(currentPage.slug))![0];
-const prevPage =
- pages[pages.findIndex((page: any) => page.id === currentPage.id) - 1];
-const nextPage =
- pages[pages.findIndex((page: any) => page.id === currentPage.id) + 1];
+const index = allPages.indexOf(currentPage.slug);
+const prevPageId = allPages[index - 1];
+const nextPageId = allPages[index + 1];
+
+const [prevPage, nextPage] = await Promise.all([
+ prevPageId && getEntry("docs", prevPageId),
+ nextPageId && getEntry("docs", nextPageId),
+]);
---
+
+
-
-