https://github.com/fatiando/birs2023-introduction
Slides for a short talk about the Fatiando project for our BIRS 2023 workshop
https://github.com/fatiando/birs2023-introduction
Last synced: 30 days ago
JSON representation
Slides for a short talk about the Fatiando project for our BIRS 2023 workshop
- Host: GitHub
- URL: https://github.com/fatiando/birs2023-introduction
- Owner: fatiando
- License: other
- Created: 2023-07-21T08:11:50.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-30T10:12:29.000Z (almost 3 years ago)
- Last Synced: 2025-11-22T12:21:58.632Z (8 months ago)
- Language: JavaScript
- Homepage: http://www.fatiando.org/birs2023-introduction/
- Size: 18.2 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# The Fatiando a Terra project | BIRS 2023
This is a short presentation about the history of the Fatiando project
for our [BIRS 2023 workshop](https://birs-2023.softwareunderground.org/)
with the [SimPEG](https://simpeg.xyz/) community.
YouTube recording of the talk: https://www.youtube.com/watch?v=hC2Ukdceyck
> Created from the reveal.js talk template:
> https://github.com/leouieda/talk-template
## What's included
`index.html`: This is the master document that sets up reveal.js and
its plugins and loads the slide content from `slides.md`.
**Change the HTML `` tag here**.
`slides.md`: Markdown file with the actual slide content. The template
includes some slides that demo the custom CSS classes available.
**Add your content here.**
`css/style.less`: Custom styling and CSS classes (using
[Less](http://lesscss.org/)). Edit to tweak colours, sizes, fonts,
spacing, etc.
`assets`: Images used in the presentation. You can probably delete all
of these when making your slides. Replace the `favicon.png` with a
32 x 32 px image to customize the icon (this is set in `index.html`).
`fonts`: Sources for the fonts used:
[FontAwesome](https://fontawesome.com/),
[Atkinson Hyperlegible](https://brailleinstitute.org/freefont),
[Ubuntu Mono](https://design.ubuntu.com/font/).
Included in the repository for offline access. You could remove them and
include fonts from a CDN (like Google Fonts) in `index.html`.
`packages`: "Vendored" versions of reveal.js, Less, and
[KaTeX](https://katex.org/) (for maths) that are used.
Having them in the repository is important for using the slides offline
(on a plane or lecture room without easy internet access).
`serve.py`: Python script that serves the slides and reloads them
whenever the source files change. Very handy for development.
See below for instructions.
## Serving the slides locally
Unfortunately, you can't just open the `index.html` file on browser
to view your slides.
Reveal.js requires an actual local server.
You can set one up however you'd like.
Below, I provide instructions for doing so in Python (which is what
I use most of the time) but it would work with any other local
server.
First, install the [livereload](https://github.com/lepture/python-livereload)
Python package:
```
pip install livereload
```
or
```
conda install livereload -c conda-forge
```
Then, start a server at http://localhost:8008 by running:
```
python serve.py
```
The slides will open on your default browser and will automatically reload
when you update any of the files in the repository.
## Serving on GitHub Pages
Go to your repository "Settings > Pages" and select "Source" as the
`main` branch and `/ (root)`. You probably want to select "Enforce HTTPS"
as well.
Your slides should now be served at https://USERNAME.github.io/REPOSITORY
or equivalent if you're using a custom domain.
It may take a little while for this to happen.
## Exporting to PDF
You can save your slides to PDF for a backup or to distribute
(I find students like this because they can annotate the PDF).
To do so, add `?print-pdf` to the end of the URL (either local
server or hosted) and then print the page to PDF.
This **works best on Chrome/Chromium**. The slides tend to be
distorted on Firefox for some reason.
**WARNING:** Videos and gifs don't work on PDFs.
## License
The template (`slides.md`, `index.html`, and `css/style.less`) is licensed under a
Creative Commons
Attribution 4.0 International License.