diff --git a/README.md b/README.md index a215254..8aedcaf 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,23 @@ # 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](https://jupyter.org/install) to enable converting notebooks @@ -21,12 +27,14 @@ If you're unable to complete these steps, feel free to raise a pull request with - Run `npm run dev`, have a look to make sure you're guide is rendering correctly ## Project Overview + It's built with [VuePress V2](https://v2.vuepress.vuejs.org/guide/getting-started.html) which is currently in beta, the main configuration comes from [vuepresss.config.ts](vuepress.config.ts), while [vuepress.client.ts](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](.vuepress/public) and [.vuepress/styles](.vuepress/styles) -The homepage comes from [index.md](index.md), there is some custom Vue code I've taken from https://nushell.sh to generate the blog links in [components](components), and to generate the tables in [guides/index.md](guides/index.md). +The homepage comes from [index.md](index.md), there is some custom Vue code I've taken from to generate the blog links in [components](components), and to generate the tables in [guides/index.md](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](syntax/mojo.tmLanguage.json) thanks to [crisadamo](https://github.com/crisadamo/mojo-lang-syntax). ## Contributions + - Thanks very much to [gautam-e](github.com/gautam-e) and [StitchyPie](https://github.com/StitchyPie) for contributing guides - And thanks to all the corrections from [pp123456](github.com/pp123456), [futureofworld](github.com/futureofworld) and [Alex19578](github.com/pp123456)