Create a generator that converts the json file into the README.md file #22
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
- Break the intro off the readme file so that we can still manage it - Create a generator to do the hard work for us - Allow for multiple resources per item by looping and generating links
Andy-set-studio
changed the title
Andy-set-studio
changed the title
| - [ ] Use textual labels to make voice activation cues obvious | ||
| - [ ] Do not mark up subheadings/straplines with separate heading elements | ||
| - [ ] Ensure primary calls to action are easy to recognize and reach | ||
| - [ ] Avoid images of text — text that cannot be translated, selected, or understood by assistive tech | ||
| - [ ] Provide a print stylesheet (single column, with interactive content hidden) | ||
| - [ ] Use well-established, therefore recognizable, icons and symbols | ||
| - [ ] Subset fonts to just the characters needed | ||
| - [ ] Instead of obstructing users with CAPTCHAs, use [honeypots](https://en.wikipedia.org/wiki/Honeypot_(computing)) | ||
| - [ ] Instead of obstructing users with CAPTCHAs, use [honeypots [Resource #1](https://en.wikipedia.org/wiki/Honeypot_(computing)) |
peter-mouland
suggested changes
Nov 30, 2017
| - [ ] Begin long, multi-section documents with a table of contents | ||
| - [ ] Don't make users perform actions to reveal content unless completely necessary | ||
| - [ ] Don"t make users perform actions to reveal content unless completely necessary |
|
@peter-mouland, Yeh they're all from |
|
@hankchizljaw Not clear on the status of this pull request. Can I merge or are you still tweaking? |
|
Yeh the generator is good to go mate. I think we could tackle the pre-commit in a separate PR. I think we could work out how to integrate and the pre-commit as a group. I started off a bit of a discussion in #1. We should probably split out into another issue though? |
|
@hankchizljaw Sounds good (the new issue I mean) |
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.
About this PR
I've made a little generator with node that will convert the
checklist.jsonfile intoREADME.md. It's bare-bones ES5 to make sure it's as easy to run as possible. The only prerequisite is that the user has node installed on their machine.I also split the readme up by creating
intro.md. This is so we can continue to manage the content of it in a reasonable fashion.To run the generator, run:
node generator/index.js