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

Convert slides to markdown #49

Merged
merged 2 commits into from
Jul 25, 2023
Merged

Conversation

larsks
Copy link
Contributor

@larsks larsks commented Jul 22, 2023

I've converted the slides from html to markdown using pandoc and the magic
of manual editing. The slides are loaded from slides.md by index.html.
I believe this makes both the prose and code examples easier to edit.

I have reproduced the navigation structure of the original slides.

@larsks
Copy link
Contributor Author

larsks commented Jul 22, 2023

Hey, apologies for the unsolicited re-architecture of the docs. I was thinking about updating some of the code samples, but when I realized that meant editing code in an HTML document I was sad.

I'm pretty sure the markdown version renders identically to the html version, with the exception of the definitions (which are now a <ul> because there isn't standard markdown support for definition lists).

@codecov
Copy link

codecov bot commented Jul 22, 2023

Codecov Report

Merging #49 (b08e810) into master (7c42020) will not change coverage.
The diff coverage is n/a.

❗ Current head b08e810 differs from pull request most recent head 2d10d97. Consider uploading reports for the commit 2d10d97 to get more accurate results

@@           Coverage Diff           @@
##           master      #49   +/-   ##
=======================================
  Coverage   49.83%   49.83%           
=======================================
  Files          66       66           
  Lines        3921     3921           
=======================================
  Hits         1954     1954           
  Misses       1752     1752           
  Partials      215      215           

@larsks larsks force-pushed the feature/markdown-slides branch 2 times, most recently from 3a066c0 to b08e810 Compare July 22, 2023 17:52
I've converted the slides from html to markdown using pandoc and the magic
of manual editing. The slides are loaded from `slides.md` by `index.html`.
I believe this makes both the prose and code examples easier to edit.

I have reproduced the navigation structure of the original slides.

Signed-off-by: Lars Kellogg-Stedman <[email protected]>
Signed-off-by: Steffen Vogel <[email protected]>
@stv0g
Copy link
Collaborator

stv0g commented Jul 25, 2023

Hi @larsks,

thanks for restructuring the docs :) I've done another pass at making them easier to read by harmonizing indentation and removing some for the cryptic abbreviations.

@stv0g stv0g merged commit 40e87f4 into cunicu:master Jul 25, 2023
4 checks passed
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.

2 participants