-
Notifications
You must be signed in to change notification settings - Fork 59
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat!: build/Actions improvements; Markup -> HTML (#14)
* Added referencing a nuget package * Use GitHub Actions to generate HTML * Updated README to reflect new home --------- Co-authored-by: ⚙︎ Greg <[email protected]> Co-authored-by: Ruben Bartelink <[email protected]>
- Loading branch information
1 parent
acff9a0
commit 3425c66
Showing
14 changed files
with
145 additions
and
556 deletions.
There are no files selected for viewing
This file contains 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,41 @@ | ||
name: Build | ||
on: [push] | ||
jobs: | ||
|
||
# BUILD | ||
build: | ||
name: Convert to HTML | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v4 | ||
- uses: ZacJW/[email protected] | ||
with: | ||
input_files: '[["docs/*.md"]]' | ||
output_files: '["docs/index.html"]' | ||
builtin_stylesheet: 'docs/fsharp-cheatsheet.css' | ||
packages: 'pymdown-extensions' | ||
extensions: '["pymdownx.extra"]' | ||
- uses: actions/[email protected] | ||
with: | ||
path: 'docs/' | ||
|
||
# DEPLOY | ||
deploy: | ||
needs: build | ||
|
||
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment | ||
permissions: | ||
pages: write # to deploy to Pages | ||
id-token: write # to verify the deployment originates from an appropriate source | ||
|
||
# Deploy to the github-pages environment | ||
environment: | ||
name: github-pages | ||
url: ${{ steps.deployment.outputs.page_url }} | ||
|
||
# Specify runner + deployment step | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Deploy to GitHub Pages | ||
id: deployment | ||
uses: actions/deploy-pages@v2 # |
This file contains 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,21 +1,27 @@ | ||
fsharp-cheatsheet | ||
================= | ||
|
||
A typesetted F# Cheatsheet in PDF and HTML formats using F# literate tools | ||
An F# Cheatsheet in Markup and HTML formats | ||
|
||
## Introduction | ||
|
||
This is an attempt to replace the old and obsolete [F# Cheat Sheet](http://www.samskivert.com/code/fsharp/fsharp-cheat-sheet.pdf). | ||
|
||
The raw content of this cheatsheet can be edited at [fsharp-cheatsheet.md](docs/fsharp-cheatsheet.md). | ||
|
||
In order to build PDF and HTML documentation, please run the build script in [build.cmd](tools/build.cmd). We assume that `pdflatex.exe` is in PATH variable to be able generate PDF files. | ||
HTML version is online at https://spiraloss.github.io/fsharp-cheatsheet | ||
|
||
## Contributing | ||
|
||
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. | ||
|
||
PDF version can be downloaded [here](https://github.com/dungpa/fsharp-cheatsheet/raw/gh-pages/fsharp-cheatsheet.pdf). | ||
HTML version is online at http://dungpa.github.io/fsharp-cheatsheet/. | ||
Primary maintainer: @SpiralOSS (backup: @bartelink) | ||
|
||
**Comments, suggestions and corrections are always welcome.** | ||
## Acknowledgements | ||
|
||
Anh-Dung Phan (@dungpa) created and maintained the repo for many years before donating it to community ownership under fsprojects | ||
|
||
The original inspiration was the (now obsolete) http://www.samskivert.com/code/fsharp/fsharp-cheat-sheet.pdf | ||
|
||
## License | ||
|
||
The documents are available under Apache 2.0 license. | ||
For more information see the [License file](LICENSE.md). |
This file contains 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,77 @@ | ||
body { | ||
font-family: 'Arial', sans-serif; | ||
margin: 40px auto; | ||
max-width: 800px; | ||
line-height: 1.6; | ||
color: #333; | ||
background-color: #f7f7f7; | ||
} | ||
|
||
h1, h2, h3, h4, h5, h6 { | ||
margin-top: 1.2em; | ||
} | ||
|
||
h1 { | ||
font-size: 2em; | ||
border-bottom: 2px solid #ddd; | ||
} | ||
|
||
h2 { | ||
font-size: 1.5em; | ||
} | ||
|
||
h3 { | ||
font-size: 1.3em; | ||
} | ||
|
||
p { | ||
margin-bottom: 1.2em; | ||
} | ||
|
||
a { | ||
color: #0077cc; | ||
text-decoration: none; | ||
} | ||
|
||
a:hover { | ||
text-decoration: underline; | ||
} | ||
|
||
strong { | ||
font-weight: bold; | ||
} | ||
|
||
em { | ||
font-style: italic; | ||
} | ||
|
||
ul, ol { | ||
margin: 20px 0; | ||
padding-left: 40px; | ||
} | ||
|
||
li { | ||
margin-bottom: 10px; | ||
} | ||
|
||
blockquote { | ||
border-left: 4px solid #ddd; | ||
padding-left: 15px; | ||
margin: 20px 0; | ||
font-style: italic; | ||
} | ||
|
||
code { | ||
font-family: 'Courier New', monospace; | ||
background-color: #eee; | ||
padding: 2px 5px; | ||
border-radius: 3px; | ||
} | ||
|
||
pre { | ||
font-family: 'Courier New', monospace; | ||
background-color: #eee; | ||
padding: 10px; | ||
border-radius: 3px; | ||
overflow-x: auto; | ||
} |
This file contains 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
Binary file not shown.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.