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

try generating markdown #28

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

try generating markdown #28

wants to merge 1 commit into from

Conversation

Nilstrieb
Copy link
Sponsor Collaborator

this is WIP but its looking interesting already

the idea: we keep the current code snippets, additionally we add expalnations in explanations/unsafe_1.md which also contain the titles, then we assemble all of the explanations and code samples+stderr together to make something great. we match the file name for it.

the current implementation needs to be improved and stuff needs to be ported.

@WaffleLapkin
Copy link
Collaborator

WaffleLapkin commented May 14, 2024

Can we put explanations and code in the same directory?

The current structure is somewhat annoying is that the explanation and code live so far apart.

  • They are lonely
  • It's harder than necessary to write explanations, because switching to code is inconvenient

imo we could have whatever_directory/unsafe_1.rs + whatever_directory/unsafe_1.md (or, even better, dir/unsafe/_1.rs and dir/unsafe/1.md, although I'm not sure how to setup the rust projects to allow unsafe/_1.rs...).

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.

None yet

2 participants