Skip to content

Latest commit

 

History

History
40 lines (25 loc) · 1.86 KB

README.md

File metadata and controls

40 lines (25 loc) · 1.86 KB
Raw

mojodojo.dev

This website is for learning resources for the Mojo 🔥 programming language.

Local Development

First install the npm packages:

npm i

Then start the dev server:

npm run dev

Contributing a guide

If you're unable to complete these steps, feel free to raise a pull request with just the .ipynb

  • Install Jupyter to enable converting notebooks
  • Put your .ipynb in the desired folder in guides
  • Run npm run docs
  • Add the md filename to vuepress.config.ts e.g. /guides/std/MyGuide.md,
  • Run npm run dev, have a look to make sure you're guide is rendering correctly

Project Overview

It's built with VuePress V2 which is currently in beta, the main configuration comes from vuepress.config.ts, while vuepress.client.ts contains client-side configuration like redirects to keep old social media links alive, the css and static images can be modified in .vuepress/public and .vuepress/styles

The homepage comes from index.md, there is some custom Vue code I've taken from https://nushell.sh to generate the blog links in components, and to generate the tables in guides/index.md.

The syntax highlighting comes from shiki which is what VS Code uses, the definition for the Mojo language is in syntax/mojo.tmLanguage.json thanks to crisadamo.

Contributions