feat: initial commit of wdl-doc documentation page style
#262
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
claymcleod
changed the title
wdl-docs stylewdl-doc documentation page style
claymcleod
commented
Jan 25, 2025
| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><title>read_group_to_string</title><link rel="stylesheet" type="text/css" href="/Users/afrantz/wdl/wdl-doc/theme/dist/styles.css"></head></html><h1>read_group_to_string</h1><h2>Meta</h2><ul><li><b>description:</b> "Stringifies a ReadGroup struct"</li><li><b>outputs:</b> { |
There was a problem hiding this comment.
- We should remove the references to your home directory somehow.
- It looks like the
<html>tag closes before your elements are added in.
There was a problem hiding this comment.
- Already got a WIP addressing that by using a relative path instead (though it complicates things a touch). I noticed that right after I made the WIP commit.
- I'll look into this!
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.
This PR adds a basic style scaffold for producing the CSS file used in
wdl-doc. Styles can be added in thesrcfolder and compiled into development (pnpm run dev, watches the directory and serves theexample.htmlfile live) or production (pnpm run prod, which needs a subsequentpnpm run serveto serve theexample.htmlfile).You can update the
example.htmlfile with a fully-featured generated page that we can test with.pnpm, as it's way better thannpmin my experience.Before submitting this PR, please make sure:
CHANGELOG.md(see"keep a changelog" for more information).