Skip to content

Commit 0fafaea

Browse files
authored
Build changes + some content (#38)
1 parent 51e0f11 commit 0fafaea

File tree

4 files changed

+875
-641
lines changed

4 files changed

+875
-641
lines changed

.github/workflows/_build.yml

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,27 @@ jobs:
88
runs-on: ubuntu-latest
99
steps:
1010
- uses: actions/checkout@v4
11-
- uses: ZacJW/[email protected]
12-
with:
13-
input_files: '[["docs/*.md"]]'
14-
output_files: '["docs/index.html"]'
15-
builtin_stylesheet: 'docs/fsharp-cheatsheet.css'
16-
packages: 'pymdown-extensions'
17-
extensions: '["pymdownx.extra"]'
18-
- uses: docker://pandoc/latex:2.9
11+
12+
- uses: baileyjm02/markdown-to-pdf@v1
1913
with:
20-
args: >-
21-
--standalone
22-
--output=docs/fsharp-cheatsheet.pdf
23-
docs/fsharp-cheatsheet.md
24-
- uses: actions/[email protected]
14+
input_dir: docs
15+
output_dir: build_outputs
16+
# images_dir: docs/images
17+
# for example <img src="./images/file-name.png">
18+
# image_import: ./images
19+
# Default is true, can set to false to only get PDF files
20+
build_pdf: true
21+
build_html: true
22+
table_of_contents: true
23+
template: docs/template.html
24+
25+
- name: Rename HTML file to index.html
26+
run: |
27+
sudo mv build_outputs/fsharp-cheatsheet.html build_outputs/index.html || echo "File not found, no rename needed"
28+
29+
- uses: actions/upload-pages-artifact@v3
2530
with:
26-
path: 'docs/'
31+
path: build_outputs/
2732

2833
# DEPLOY
2934
deploy:
@@ -44,4 +49,4 @@ jobs:
4449
steps:
4550
- name: Deploy to GitHub Pages
4651
id: deployment
47-
uses: actions/deploy-pages@v2 #
52+
uses: actions/deploy-pages@v4

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,17 @@ fsharp-cheatsheet
33

44
An F# Cheatsheet in Markup and HTML formats
55

6-
## Introduction
76

8-
The raw content of this cheatsheet can be edited at [fsharp-cheatsheet.md](docs/fsharp-cheatsheet.md).
7+
- [View the cheatsheet online](https://fsprojects.github.io/fsharp-cheatsheet)
8+
- [Download the PDF](https://fsprojects.github.io/fsharp-cheatsheet/fsharp-cheatsheet.pdf)
99

10-
HTML version is online at https://fsprojects.github.io/fsharp-cheatsheet
10+
## Contributing
1111

12-
PDF version is online at https://fsprojects.github.io/fsharp-cheatsheet/fsharp-cheatsheet.pdf
12+
The raw content of this cheatsheet can be edited at [fsharp-cheatsheet.md](docs/fsharp-cheatsheet.md).
1313

14-
## Contributing
14+
This resource was, is, and should remain a community effort. If you're learning F# and something you discovered was important wasn't covered, you're the very best person to point that out and phrase it in a way that someone new can get running with.
1515

16-
This resource was, is and should remain a community effort. If you're learning F# and something important you didn't learn about isn't covered, you're the very best person to point that out and phrase it in a way that someone new can get running with. If someone posts a PR, the more diversity of reviewers we get, the better. That said, the best PRs are small ones that touch one piece at a time and can hence be reviewed and merged rapidly.
16+
The more diversity of reviewers we get, the better. That said, the best PRs are small ones that touch one piece at a time and can hence be reviewed and merged rapidly.
1717

1818
Primary maintainer: @SpiralOSS (backup: @bartelink)
1919

0 commit comments

Comments
 (0)