diff --git a/Coding-Style-Guide:-Wiki.md b/Coding-Style-Guide:-Wiki.md new file mode 100644 index 0000000..8d438ce --- /dev/null +++ b/Coding-Style-Guide:-Wiki.md @@ -0,0 +1,74 @@ +## General Wiki Code Style + +Keeping an open wiki that everyone can edit is important to the project, and spirit of the project. However, some constancy in markdown formatting goes a long way to make the wiki look as good as it is informative. + +Following these guidelines while making the readme for your plugin/theme would be recommended as well, but is not required. + +--- + +## Headers + +| GFM Element | HTML Header Tag Equivalent | Use | +| ----------- | -------------------------- | ------------------------------------------------------------------------------ | +| # | `

` | This will not be used as Github wiki pages uses the filename as h1 | +| ## | `

` | Main section divider (as in this page _Headers, Syntax Highlighting_, etc are) | +| ### - #### | `

` - `

` | For use in subsections | +| ##### | `

` | Please try to use this just for labeling _Example_ in fenced code blocks | +| ###### | `
` | For descriptors in example fenced code blocks | + +Below is an example of how to use each header (and will be the only use of ##/h2 in abnormal circumstances). + +___ + +## This is a main subject (h2) +### This subject has several important sub-subjects (h3) +#### Some sub-subjects are so vast, they require their own sub-subjects (h4) +##### _Example:_ (h5) +###### _Quick explanation of example:_ (h6) + +___ + +## Tables + +Tables are pretty and easy to read, please use them whenever possible for listing aliases, functions, and anything else that could possibly be made into a table. + +## Syntax Highlighting + +We use _shell_ to highlight code blocks. GFM does support highlighting zsh defined code blocks. However, some text editors do not, so this just makes the experience more consistent across the board. + +## Line Wrapping + +Do not hard wrap lines. + +## Italics + +Use underscores to define italics and not asterisk's. (This makes it easier to differentiate from bold words/characters at glance in when editing.) + +## Bold + +Use asterisk's to define bold characters/words, not underscores. (This makes it easier to differentiate from bold words/characters at glance in when editing.) + +## Unnumbered lists + +Use dashes `-` for defining unnumbered lists and sublists apposed to asterisks. + +## Images + +Use Markdown formatting for images, **not html** + +###### _Example:_ +```markdown +![image description](url to image) +``` + +## Line Endings + +Please use Unix line ending codes and not Windows (MacOS 10+ uses Unix by default). + +### EOF + +Please leave a blank newline at the end of the file. + +## Miscellaneous + +Page breaks such as `---`, `___`, and `===` don't have to be used, but if so, there are no strict guidelines on using them, just don't _over use_ them.