Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
| Warning |
|---|
Early draft, locked down to Ian and Ed-Fi staff. |
Ed-Fi technical documentation is increasingly moving toward Markdown-flavored text files stored alongside the source code. While GitHub and some preview utilities will provide beautiful styling to Markdown, there is value in applying good pure-text styling for easy readability without the preview. Indeed, that is the true value of Markdown - the brain can interpret the pure-text styling with ease, even while reading in a command prompt with no graphical user interface.
Tool Recommendation
Visual Studio Code is a terrific Markdown editor. The markdownlint extension will help identify and solve many stylistic problems and is highly recommended. Atom users should be able to rely on linter-node-markdownlint for the same ruleset and similar experience.
Contents
| Table of Contents |
|---|