-
Notifications
You must be signed in to change notification settings - Fork 64
mdbook setup #121
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
Merged
Merged
mdbook setup #121
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
eea73c5
Enable mdbook to build html
Seasawher 838111e
set up the deploy workflow
Seasawher e00f797
Merge branch 'master' into mdbook
Seasawher ffdcc78
test: setup deploy workflow
Seasawher 468219c
delete markdown files, which are generated by mdgen
Seasawher fbc732b
update gitignore file
Seasawher c753cff
Merge branch 'leanprover-community:master' into master
Seasawher 8b8b7fa
modify deploy workflow using mdgen
Seasawher 57a83f9
add github badge to book
Seasawher 71dd66d
modify workflow: don't deploy from non-master branch
Seasawher File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
name: Deploy to github pages | ||
|
||
on: [push, pull_request] | ||
|
||
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | ||
permissions: | ||
contents: read | ||
pages: write | ||
id-token: write | ||
|
||
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | ||
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | ||
concurrency: | ||
group: "pages" | ||
cancel-in-progress: false | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: checkout | ||
uses: actions/checkout@v4 | ||
|
||
- name: install elan | ||
run: | | ||
curl https://raw.githubusercontent.com/leanprover/elan/master/elan-init.sh -sSf | sh -s -- -y --default-toolchain $(cat lean-toolchain) | ||
echo "$HOME/.elan/bin" >> $GITHUB_PATH | ||
|
||
# note: `lake run build` raise an error in GitHub Action | ||
- name: build markdown files by mdgen | ||
run: lake exe mdgen lean md | ||
|
||
- name: setup mdBook | ||
uses: peaceiris/actions-mdbook@v1 | ||
with: | ||
mdbook-version: '0.4.32' | ||
|
||
- name: build html from markdown | ||
run: mdbook build | ||
|
||
- name: upload artifact | ||
uses: actions/upload-pages-artifact@v2 | ||
with: | ||
path: ./book | ||
|
||
deploy: | ||
if: github.ref == 'refs/heads/master' | ||
environment: | ||
name: github-pages | ||
url: ${{ steps.deployment.outputs.page_url }} | ||
runs-on: ubuntu-latest | ||
needs: build | ||
steps: | ||
- name: Deploy to GitHub Pages | ||
id: deployment | ||
uses: actions/deploy-pages@v3 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,5 @@ | ||
/build | ||
.lake/ | ||
.lake/ | ||
book | ||
md/ | ||
!md/SUMMARY.md |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
[book] | ||
authors = ["Arthur Paulino, Damiano Testa, Edward Ayers, Evgenia Karunus, Henrik Böving, Jannis Limperg, Siddhartha Gadgil, Siddharth Bhat"] | ||
language = "en" | ||
multilingual = false | ||
src = "md" | ||
title = "Metaprogramming in Lean 4" | ||
|
||
[output.html] | ||
git-repository-url = "https://github.com/leanprover-community/lean4-metaprogramming-book" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
# Summary | ||
|
||
- [Introduction](./main/01_intro.md) | ||
- [Overview](./main/02_overview.md) | ||
- [Expressions](./main/03_expressions.md) | ||
- [MetaM](./main/04_metam.md) | ||
- [Syntax](./main/05_syntax.md) | ||
- [Macros](./main/06_macros.md) | ||
- [Elaboration](./main/07_elaboration.md) | ||
- [Embedding DSLs By Elaboration](./main/08_dsls.md) | ||
- [Tactics](./main/09_tactics.md) | ||
- [Lean4 Cheat-sheet](./main/10_cheat-sheet.md) | ||
|
||
# Extra | ||
|
||
- [Options](./extra/01_options.md) | ||
- [Attributes]() | ||
- [Pretty Printing](./extra/03_pretty-printing.md) |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.