refactor: Use Markdown tables for rendering cheat sheets #66
Conversation
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
These are styled differently by ex_doc, but are also more appropriate for the types of content we're generating
…ions and arguments This allows ex_doc to parse the content and add links to other pages and modules
|
Very nice :) now I need to decide if I want to update spark for all projects and regen docs or not 😂 could also just let them update when they update. |
|
Let them update when they update, IMO. There is one small issue - because the generated cheat sheets have changed their format, the first time docs are generated for a project, it will raise an error. This is because the list of files for Subsequent runs work, so I'm not sure if its worth spending too much time on. |
|
Yeah, I think I can live with that :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Also uses regular Markdown files for cheat sheets instead of
.cheatmdfiles.All functionality like required stars and links to each individual option/argument is retained, using Markdown shenanigans (that doesn't seem to be documented anywhere but works? Saw it on Stack Overflow)
Benefits:
Screenshots of a tiny part of the Resource DSL docs:
(note: table borders in the "After" screenshot are still in an ex_doc PR)