Skip to content
This repository was archived by the owner on Aug 26, 2024. It is now read-only.

Commit 10cbeda

Browse files
committed
feat: 🎉 get basics done
1 parent 884a38d commit 10cbeda

File tree

13 files changed

+151
-0
lines changed

13 files changed

+151
-0
lines changed

.github/workflows/build.yml

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: Build Typst document
2+
on: [push, workflow_dispatch]
3+
4+
permissions:
5+
contents: write
6+
7+
jobs:
8+
build:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- name: Checkout
12+
uses: actions/checkout@v4
13+
- name: Install Typst
14+
uses: baptiste0928/cargo-install@v2
15+
with:
16+
crate: typst-cli
17+
git: https://github.com/typst/typst
18+
branch: main
19+
- name: Install just
20+
uses: baptiste0928/cargo-install@v2
21+
with:
22+
crate: just
23+
- name: Clone Notebookinator
24+
uses: actions/checkout@v4
25+
with:
26+
repository: battlech1cken/notebookinator
27+
path: ./notebookinator
28+
ref: main
29+
- name: Install Notebookinator
30+
run: |
31+
cd notebookinator
32+
just install
33+
- name: Compile Notebook
34+
run: |
35+
typst compile main.typ --font-path ./assets/fonts/
36+
- name: Upload PDF file
37+
uses: actions/upload-artifact@v3
38+
with:
39+
name: notebook
40+
path: main.pdf

.github/workflows/typos.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: Spell Check
2+
on: [push, workflow_dispatch]
3+
4+
jobs:
5+
spelling:
6+
runs-on: ubuntu-latest
7+
steps:
8+
- name: Checkout
9+
uses: actions/[email protected]
10+
11+
- name: Spell Check with Typos
12+
uses: crate-ci/typos@master
13+
with:
14+
config: ./typos.toml

.gitignore

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
.direnv
2+
*.pdf
3+
result
4+
.devcontainer
5+
notebookinator
6+
node_modules

.husky/pre-commit

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
#!/bin/bash
2+
3+
npm run typos:check
4+
npm run format:check
5+
npm run build

assets/781X-logo.png

490 KB
Loading

assets/fonts/telemarines1.ttf

24.4 KB
Binary file not shown.

entries/entries.typ

Whitespace-only changes.

main.typ

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
#import "/packages.typ": notebookinator
2+
#import notebookinator: *
3+
#import themes.radial: radial-theme, components
4+
5+
#show: notebook.with(theme: radial-theme, cover: align(center)[
6+
#text(size: 24pt, font: "Tele-Marines")[
7+
#v(3em)
8+
#text(size: 28pt)[
9+
Second Notebook
10+
]
11+
12+
#image("./assets/781X-logo.png", height: 60%)
13+
14+
2023 - 2024
15+
#line(length: 50%, stroke: (thickness: 2.5pt, cap: "round"))
16+
Over Under
17+
18+
]
19+
])
20+
21+
#create-frontmatter-entry(title: "Table of Contents")[
22+
#components.toc()
23+
]
24+
25+
#include "entries/entries.typ"
26+
27+
// #include "./appendix.typ"

package-lock.json

Lines changed: 27 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: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"devDependencies": {
3+
"husky": "^9.0.11"
4+
},
5+
"scripts": {
6+
"format:check": "find ./ -iname \"*.typ\" | xargs typstfmt --check --verbose",
7+
"format:fix": "find ./ -iname \"*.typ\" | xargs typstfmt",
8+
"typos:check": "typos",
9+
"typos:fix": "typos -w",
10+
"prepare": "husky",
11+
"install": "./prepare.sh",
12+
"build": "typst compile main.typ --font-path ./assets/fonts/"
13+
}
14+
}

packages.typ

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
// Provides a centralized way to specify package versions
2+
3+
#import "@local/notebookinator:1.0.0"
4+
#import "@preview/codetastic:0.2.2"
5+
#import "@preview/diagraph:0.1.0"

prepare.sh

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
git clone https://github.com/BattleCh1cken/notebookinator
2+
cd notebookinator
3+
just install
4+
cd ..
5+
6+
cargo install typst-live
7+
cargo install --git https://github.com/astrale-sharp/typstfmt.git --tag 0.2.7
8+
cargo install typos-cli

typos.toml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
[files]
2+
extend-exclude = ["*.md"]
3+
4+
[default.extend-words]
5+
Pilons = "Pilons"

0 commit comments

Comments
 (0)