Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Switch to mdBook #32

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .envrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
#!/bin/bash

if ! has nix_direnv_version || ! nix_direnv_version 3.0.6; then
source_url "https://raw.githubusercontent.com/nix-community/nix-direnv/3.0.6/direnvrc" "sha256-RYcUJaRMf8oF5LznDrlCXbkOQrywm0HDv1VjYGaJGdM="
fi

use flake
29 changes: 29 additions & 0 deletions .github/workflows/mdbook-to-github-pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: github pages

on:
push:
branches:
- main
pull_request:

jobs:
deploy:
runs-on: ubuntu-20.04
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
steps:
- uses: actions/checkout@v2

- name: Setup mdBook
uses: peaceiris/actions-mdbook@v2
with:
mdbook-version: '0.4.10'
# mdbook-version: 'latest'

- run: mdbook build

- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./book
8 changes: 2 additions & 6 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,2 @@
.DS_Store
/node_modules/
/src/node_modules/@sapper/
yarn-error.log
/cypress/screenshots/
/__sapper__/
.direnv
book
10 changes: 10 additions & 0 deletions book.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
[book]
authors = ["Craig Barber"]
language = "en"
multilingual = false
src = "src"

[output.html]
additional-css = ["./theme/catppuccin.css", "./theme/catppuccin-admonish.css"]
default-theme = "latte"
preferred-dark-theme = "macchiato"
4 changes: 0 additions & 4 deletions cypress.json

This file was deleted.

5 changes: 0 additions & 5 deletions cypress/fixtures/example.json

This file was deleted.

19 changes: 0 additions & 19 deletions cypress/integration/spec.js

This file was deleted.

17 changes: 0 additions & 17 deletions cypress/plugins/index.js

This file was deleted.

25 changes: 0 additions & 25 deletions cypress/support/commands.js

This file was deleted.

20 changes: 0 additions & 20 deletions cypress/support/index.js

This file was deleted.

25 changes: 25 additions & 0 deletions flake.nix
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
inputs = {
nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
flake-utils.url = "github:numtide/flake-utils";
};
outputs = { self, nixpkgs, flake-utils, rust-overlay }:
flake-utils.lib.eachDefaultSystem
(system:
let
pkgs = import nixpkgs {
inherit system;
};

nativeBuildInputs = with pkgs; [ ];

buildInputs = with pkgs; [ mdbook ];
in
with pkgs;
{
devShells.default = mkShell {
inherit buildInputs nativeBuildInputs;
};
}
);
}
43 changes: 0 additions & 43 deletions package.json

This file was deleted.

13 changes: 0 additions & 13 deletions patches/sapper+0.27.9.patch

This file was deleted.

5 changes: 1 addition & 4 deletions content/docs/01-introduction.md → src/01-introduction.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
---
title: Introduction
---
# Introduction

### Before we begin


> The following is a path forward to set up your development laptop. It is not **the** path. Asking your fellow mojos will offer many alternatives.
>
> Try it out. Experiment. Change what you don't like. Don't be afraid to invest time in your workflow.
Expand Down
8 changes: 2 additions & 6 deletions content/docs/02-editors.md → src/02-editors.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,4 @@
---
title: Editors
root: '/docs'
parents: ['Get Started']
---
# Editors

Common editors and recommended plugins

Expand All @@ -19,4 +15,4 @@ https://marketplace.visualstudio.com/items?itemName=MS-vsliveshare.vsliveshare
#### Resources
* [Keyboard shortcuts for macOS](/keyboard-shortcuts-macos.png)
* [Keyboard shortcuts for Windows](/keyboard-shortcuts-windows.png)
* [Keyboard shortcuts for Linux](/keyboard-shortcuts-linux.png)
* [Keyboard shortcuts for Linux](/keyboard-shortcuts-linux.png)
6 changes: 1 addition & 5 deletions content/docs/03-projects.md → src/03-projects.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,4 @@
---
title: Projects
root: '/docs'
parents: ['Get Started']
---
# Projects

### Helios

Expand Down
6 changes: 1 addition & 5 deletions content/docs/04-project-ideas.md → src/04-project-ideas.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,4 @@
---
title: Project Ideas
root: '/docs'
parents: ['Mojo Time']
---
# Project Ideas

### Meeting preparation

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
title: Internship Interviews
---
# Internship Interviews

### Schedule + Logistics
* Probably starting around mid-May, early June; let us know your availability and we'll have a more concrete start date later
Expand Down
9 changes: 4 additions & 5 deletions content/docs/06-mentoring.md → src/06-mentoring.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
---
title: Mentoring
---
# Mentoring

### Slides

* [2020 Internship Kickoff](/slides/2020-internship.html)
* [2021 Internship Kickoff](/slides/2021-internship.html)
* [2020 Internship Kickoff](./decks/2020-internship.md)
* [2021 Internship Kickoff](./decks/2021-internship.md)
* [2022 Internship Kickoff](./decks/2022-internship.md)

### What we have

Expand Down
4 changes: 1 addition & 3 deletions content/docs/07-git-cheats.md → src/07-git-cheats.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
title: Git cheats
---
# Git cheats

### Basics
- git help *command*: get help for a git command
Expand Down
12 changes: 12 additions & 0 deletions src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Summary

- [Introduction](./01-introduction.md)
- [Editors](./02-editors.md)
- [Projects](./03-projects.md)
- [Project Ideas](./04-project-ideas.md)
- [Internship Interviews](./05-internship-interviews.md)
- [Mentoring](./06-mentoring.md)
- [2020 Internship Kickoff](./decks/2020-internship.md)
- [2021 Internship Kickoff](./decks/2021-internship.md)
- [2022 Internship Kickoff](./decks/2022-internship.md)
- [Git Cheats](./07-git-cheats.md)
5 changes: 0 additions & 5 deletions src/client.js

This file was deleted.

Loading
Loading