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

Documentation workflow based on Kindly & Clay #119

Merged
merged 64 commits into from
Dec 24, 2023

Conversation

daslu
Copy link
Member

@daslu daslu commented Dec 8, 2023

edit: corrected parhs

New experimental dev workflow

This PR is part of our work on a new dev workflow for Tablecloth:

  • namespace-as-a-notebook documentation using Kindly and Clay -- this PR
  • testing the documentation using note-to-test -- coming soon

Status

Not to be merged yet.
There are still some rendering issues (e.g. in the layout of R code output).

Relevant files

  • notebooks/index.clj - the tutorial as a Kindly notebook (developed with Clay)
    • dev/conversion.clj - the script used to generate the notebook from the original Rmarkdown tutorial (up to a few additional manual edits)
  • docs/index.html - the tutorial rendered using Clay and Quarto -- temporarily served at https://daslu.github.io/tablecloth

Actions

  • to render the notebook using Clay (assuming you have the Quarto CLI installed):
(require '[scicloj.clay.v2.api :as clay])
(clay/make! {:format [:quarto :html]
             :source-path "notebooks/index.clj"})

@daslu
Copy link
Member Author

daslu commented Dec 13, 2023

The tests pass now, so the PR can be merged from my perspective.

README.md Outdated Show resolved Hide resolved
@daslu
Copy link
Member Author

daslu commented Dec 24, 2023

Quoting @genmeblog on the Zulip conversation:

since my time is limited this week I can't move forward. I don't want to stop you so here is my proposal what to do with merging PR:

  • I want to keep current docs reachable somewhere (all artifacts) - so let's move it to the "old" subfolder and update all links (readme + github itself)
  • then merge Daniel's branch to enable new docs, also link to it somewhere in Readme.
  • since the merge we do not update RMarkdown anymore, changes in docs will be done only in Daniel's version

You have all rights to make the merge - feel free to do this

@daslu daslu merged commit 0deb89c into scicloj:master Dec 24, 2023
1 check 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