Creates a guide-template to update all guides from #2

Open
wants to merge 7 commits into
base: master
from

Conversation

Projects
None yet
1 participant
@bengitscode
Collaborator

bengitscode commented Dec 21, 2017

bengitscode added some commits Nov 21, 2017

Reformat markdown to begin cleanup
- Much of this will be rewritten but let's start with a happy markdown linter.
Reformat markdown and trim down from rails heroku
- Reformat markdown properly.
 - Splats * for list items not dashes.
 - Wrap to 80 chars.
- Trims some content from rails heroku setup guide, keeping just enough to have
some clear examples of what sections look like. The rails heroku setup guide is
one of our cleanest with the most consistent style, hence it's being used to
create this guide template.
Modify section on linter to new config files
- No longer using remarkrc.
- Probably just going to use markdownlint.json but I included eslintrc.json just
in case we do end up using that instead. Since this is going to be primarily, or
entirely for consultants and not the developers in WDI, it makes more sense to
use the markdownlint.json default that can be detected directly from the command
line interface. I think eslintrc.json would need to be configured separarately
in the editor environment.
Update checklist and header examples
- Updates checklist to serve as an example checklist with example headers.
Remove .remarkrc
- Removes .remarkrc as we no longer use it.
- Some of these configurations may be moved over into our markdownlint.json.
Add .markdownlint.json configuration file
- New linter config file added for consultant use.
- linter run with markdownlint README will automatically pull in this
configuration.
Rename markdownlint.json to markdownlintrc
- This is our new preferred config file as it plays well with both our cli
markdown linter, as well as linter-node-markdown in Atom's interface.
- Also removes x from checkbox and adds "example" to check list example
for clarity.
- Close wdi-bos-faculty/instructors#94
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment