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

Add mdbook and CI #2

Merged
merged 4 commits into from
Jun 18, 2021
Merged

Add mdbook and CI #2

merged 4 commits into from
Jun 18, 2021

Conversation

JonathanLorimer
Copy link
Contributor

@JonathanLorimer JonathanLorimer commented Jun 15, 2021

In this PR I have

  • added the mdbook and mdformatter dependencies via nix, while the setup uses nix flakes it also provides legacy shims with flakes-compat (so nix-shell should work)
  • initialized mdbook
  • updated the readme with getting started and non-nix instructions
  • update the readme with contributing guidelines
  • setup CI

Use nix flakes for the main workflow, and provide legacy shim via
flakes-compat

test

reset after tests

nix-shell working

remove unnecessary nix files
Add dependency installation guidelines, and contributing guidelines
Add github actions for format checks via mdformat, and mdbook build
check. Also deploys to gh-pages when merged to main.

use newer nixpkgs

use python action

fix python action

fix python action again

test failing ci

test failing ci pt2

move pages branch to main
@JonathanLorimer JonathanLorimer marked this pull request as ready for review June 16, 2021 21:48
@JonathanLorimer JonathanLorimer changed the title [WIP] Add mdbook Add mdbook and CI Jun 16, 2021
@JonathanLorimer JonathanLorimer merged commit fd68e64 into main Jun 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants