Merge pull request #2 from arcticicestudio/feature/gh-1-base-rules

Base Rules

.circleci/config.yml

@@ -0,0 +1,31 @@
+# Copyright (c) 2018-present Arctic Ice Studio <[email protected]>
+# Copyright (c) 2018-present Sven Greb <[email protected]>
+
+# Project:    Styleguide Markdown
+# Repository: https://github.com/arcticicestudio/styleguide-markdown
+# License:    MIT
+# References:
+#   https://circleci.com/docs/2.0
+#   https://circleci.com/docs/2.0/circleci-images/#nodejs
+
+version: 2
+jobs:
+  build:
+    docker:
+      - image: circleci/node:latest
+    steps:
+      - checkout
+      - run:
+          name: preprocess-clean-node-modules
+          command: rm -rf node_modules
+      - run:
+          name: preprocess-npm-install
+          command: npm install
+      - run:
+          name: lint
+          command: npm run lint
+      - run:
+          name: build-docs
+          command: npm run docs:build
+      - store_artifacts:
+          path: build/docs

.github/ISSUE_TEMPLATE.md

@@ -51,7 +51,7 @@ What actually happens?
 
 Provide a [MCVE - The Minimal, Complete, and Verifiable Example](https://github.com/arcticicestudio/styleguide-markdown/blob/develop/CONTRIBUTING.md#mcve)
 
-**This is a optional section, but it can drastically increase the speed at which this issue can be processed since it takes away the time-consuming reconstruction to reproduce the enhancement or bug.**
+Note that **this is a optional section, but it can drastically increase the speed at which this issue can be processed since it takes away the time-consuming reconstruction to reproduce the enhancement or bug.**
 
 The recommened way is to upload it as [Gist](https://gist.github.com) or new repository to GitHub, but of course you can [attach it to this issue](https://help.github.com/articles/file-attachments-on-issues-and-pull-requests), use any free file hosting service or paste the code in [Markdown code blocks](https://help.github.com/articles/basic-writing-and-formatting-syntax) into this issue.
 
@@ -70,7 +70,7 @@ If possible please provide more context by answering these questions:
 
 ## Stack Trace and Error Messages
 
-```
+```raw
 Paste the full stack trace, error messages or the logfile here ...
 ```
 

.remarkignore

@@ -0,0 +1,5 @@
+# +---------+
+# + Node.js +
+# +---------+
+src/node_modules/*
+node_modules/*

.remarkrc.js

@@ -0,0 +1,17 @@
+/*
+ * Copyright (c) 2018-present Arctic Ice Studio <[email protected]>
+ * Copyright (c) 2018-present Sven Greb <[email protected]>
+ *
+ * Project:    Arctic Ice Studio remark-lint Preset
+ * Repository: https://github.com/arcticicestudio/remark-preset-lint-arcticicestudio
+ * License:    MIT
+ */
+
+/**
+ * @file The remark-lint configuration.
+ * @author Arctic Ice Studio <[email protected]>
+ */
+
+module.exports = {
+  plugins: ["remark-preset-lint-arcticicestudio"]
+};

CONTRIBUTING.md

@@ -10,7 +10,7 @@ As for everything else in the project, the contributions to Styleguide Markdown
 
 ## Getting Started
 
-Styleguide Markdown is an open source project and we love to receive contributions from the community! There are many ways to contribute, from [writing- and improving documentation and tutorials](), [reporting bugs](#bug-reports), [submitting enhancement suggestions](#enhancement-suggestions) which can be incorporated into Styleguide Markdown itself by [submitting a pull request](#pull-requests).
+Styleguide Markdown is an open source project and we love to receive contributions from the community! There are many ways to contribute, from [writing- and improving documentation and tutorials](#documentations), [reporting bugs](#bug-reports), [submitting enhancement suggestions](#enhancement-suggestions) which can be incorporated into Styleguide Markdown itself by [submitting a pull request](#pull-requests).
 
 The project development workflow and process uses [GitHub Issues][gh-issues]- and [Pull Requests][gh-pr] management to track issues and pull requests.
 
@@ -113,7 +113,7 @@ A well-crafted Git commit message is the best way to communicate *context* about
 
 Styleguide Markdown adheres to the [Arctic Ice Studio Git Style Guide][styleguide-git-github].
 
-[![][styleguide-git-badge]][styleguide-git-github]
+[![Arctic Ice Studio Git Style Guide Badge][styleguide-git-badge]][styleguide-git-github]
 
 The style guide assumes that you are familiar with the [gitflow][gitflow] branching model.
 

README.md

@@ -4,12 +4,65 @@
 
 <p align="center"><img src="https://assets-cdn.github.com/favicon.ico" width=24 height=24/> <a href="https://github.com/arcticicestudio/styleguide-markdown/releases/latest"><img src="https://img.shields.io/github/release/arcticicestudio/styleguide-markdown.svg?style=flat-square"/></a></p>
 
-<p align="center"><a href="https://arcticicestudio.github.io/styleguide-markdown"><img src="https://img.shields.io/badge/Docs-0.1.0-5E81AC.svg?style=flat-square"/></a> <a href="https://github.com/arcticicestudio/styleguide-markdown/blob/develop/CHANGELOG.md"><img src="https://img.shields.io/badge/Changelog-0.1.0-5E81AC.svg?style=flat-square"/></a></p>
+<p align="center"><img src="https://www.npmjs.com/static/images/touch-icons/favicon-32x32.png" width=24 height=24/> <a href="https://www.npmjs.com/package/remark-preset-lint-arcticicestudio"><img src="https://img.shields.io/npm/v/remark-preset-lint-arcticicestudio.svg?style=flat-square&label=remark-preset-lint-arcticicestudio"/></a></p>
+
+<p align="center"><a href="https://arcticicestudio.github.io/styleguide-markdown"><img src="https://img.shields.io/badge/Docs----5E81AC.svg?style=flat-square"/></a> <a href="https://github.com/arcticicestudio/styleguide-markdown/blob/develop/CHANGELOG.md"><img src="https://img.shields.io/badge/Changelog----5E81AC.svg?style=flat-square"/></a></p>
 
 <p align="center"><img src="https://circleci.com/favicon.ico" width=24 height=24/> <a href="https://circleci.com/gh/arcticicestudio/styleguide-markdown"><img src="https://img.shields.io/circleci/project/github/arcticicestudio/styleguide-markdown/develop.svg?style=flat-square"/></a></p>
 
+---
+
+<p align="center"><img src="https://cdn.rawgit.com/arcticicestudio/styleguide-markdown/develop/assets/styleguide-markdown-banner-typography-badge.svg" width="40%" /></p></p>
+
+Every major open source project has its own style guide, a set of standards and conventions for the writing and design of code, documentations and assets. It is much easier to understand a large codebase when all the code in it is in a consistent style.
+
+A style guide establishes and enforces style to improve the intelligibility and communication within the project community. It ensures consistency and enforces best practice in usage and language composition.
+
+### Getting Started
+
+The [project documentation][docs] contains chapters to learn about
+the [comprehensive base rule set][docs-rules] with support for [GitHub Flavored Markdown][gfm] which is based on the [CommonMark][commonmark] specification. It includes rules for all document elements like e.g. [code blocks][docs-rules-code-blocks], [headings][docs-rules-headings] or [lists][docs-rules-lists], defines [naming conventions][docs-rules-naming-conventions] and best practices for [whitespaces][docs-rules-whitespaces], [Raw HTML][docs-rules-raw-html], [emphasizing][docs-rules-emphasis] and [strings][docs-rules-strings].
+
+The development chapters contain information about the [requirements][docs-dev-requirements] and [how to build][docs-dev-building] the style guide documentation.
+
+To make sure your code matches this style guide use the official [remark-preset-lint-arcticicestudio][remark-preset-lint-arcticicestudio-ghio] code linter preset for [remark-lint][remark-lint-gh], a plugin for [remark][].
+
+### Contributing
+
+Read the [contributing guide][docs-dev-contributing] to learn about the development process and how to propose [enhancement suggestions][docs-dev-contributing-enhancements] and [report bugs][docs-dev-contributing-bug-reports], how to [submit pull requests][docs-dev-contributing-pr] and the project's [styleguides][docs-dev-contributing-styleguides], [branch organization][docs-dev-contributing-branch-org] and [versioning][docs-dev-contributing-versioning] model.
+
+The guide also includes information about [minimal, complete, and verifiable examples][docs-dev-contributing-mcve] and other ways to contribute to the project like [improving existing issues][docs-dev-contributing-other-improve-issues] and [giving feedback on issues and pull requests][docs-dev-contributing-other-feedback].
+
 <p align="center"><img src="https://cdn.rawgit.com/arcticicestudio/nord/develop/assets/banner-footer-mountains.svg" /></p>
 
 <p align="center">Copyright &copy; 2018-present Arctic Ice Studio & Sven Greb</p>
 
 <p align="center"><a href="https://github.com/arcticicestudio/styleguide-markdown/blob/develop/LICENSE.md"><img src="https://img.shields.io/badge/License-MIT-5E81AC.svg?style=flat-square"/></a></p>
+
+[commonmark]: http://commonmark.org
+[docs]: https://arcticicestudio.github.io/styleguide-markdown
+[docs-dev-building]: https://arcticicestudio.github.io/styleguide-markdown/development/building.html
+[docs-dev-contributing]: https://arcticicestudio.github.io/styleguide-markdown/development/contributing.html
+[docs-dev-contributing-branch-org]: https://arcticicestudio.github.io/styleguide-markdown/development/contributing.html#branch-organization
+[docs-dev-contributing-bug-reports]: https://arcticicestudio.github.io/styleguide-markdown/development/contributing.html#bug-reports
+[docs-dev-contributing-enhancements]: https://arcticicestudio.github.io/styleguide-markdown/development/contributing.html#enhancement-suggestions
+[docs-dev-contributing-mcve]: https://arcticicestudio.github.io/styleguide-markdown/development/contributing.html#mcve
+[docs-dev-contributing-other-feedback]: https://arcticicestudio.github.io/styleguide-markdown/development/contributing.html#give-feedback-on-issues-and-pull-requests
+[docs-dev-contributing-other-improve-issues]: https://arcticicestudio.github.io/styleguide-markdown/development/contributing.html#improve-issues
+[docs-dev-contributing-pr]: https://arcticicestudio.github.io/styleguide-markdown/development/contributing.html#pull-requests
+[docs-dev-contributing-styleguides]: https://arcticicestudio.github.io/styleguide-markdown/development/contributing.html#styleguides
+[docs-dev-contributing-versioning]: https://arcticicestudio.github.io/styleguide-markdown/development/contributing.html#versioning
+[docs-dev-requirements]: https://arcticicestudio.github.io/styleguide-markdown/development/requirements.html
+[docs-rules]: https://arcticicestudio.github.io/styleguide-markdown/rules/index.html
+[docs-rules-code-blocks]: https://arcticicestudio.github.io/styleguide-markdown/rules/code.html#blocks
+[docs-rules-emphasis]: https://arcticicestudio.github.io/styleguide-markdown/rules/emphasis.html
+[docs-rules-headings]: https://arcticicestudio.github.io/styleguide-markdown/rules/headings.html
+[docs-rules-lists]: https://arcticicestudio.github.io/styleguide-markdown/rules/lists.html
+[docs-rules-naming-conventions]: https://arcticicestudio.github.io/styleguide-markdown/rules/naming-conventions.html
+[docs-rules-raw-html]: https://arcticicestudio.github.io/styleguide-markdown/rules/raw-html.html
+[docs-rules-strings]: https://arcticicestudio.github.io/styleguide-markdown/rules/strings.html
+[docs-rules-whitespaces]: https://arcticicestudio.github.io/styleguide-markdown/rules/whitespaces.html
+[gfm]: https://github.github.com/gfm
+[remark]: https://remark.js.org
+[remark-lint-gh]: https://github.com/remarkjs/remark-lint
+[remark-preset-lint-arcticicestudio-ghio]: https://arcticicestudio.github.io/remark-preset-lint-arcticicestudio

package.json

@@ -25,5 +25,19 @@
     "config",
     "preset"
   ],
-  "private": true
+  "private": true,
+  "scripts": {
+    "clean": "del build",
+    "docs:build": "gitbook install src && gitbook build src build/docs",
+    "docs:dev": "npm run docs:build && gitbook serve src build/docs",
+    "lint:md": "remark --no-stdout ./*.md src/ .github/",
+    "lint": "npm run lint:md",
+    "prepublishOnly": "npm run lint"
+  },
+  "devDependencies": {
+    "del-cli": "1.1.0",
+    "gitbook-cli": "2.3.2",
+    "remark-cli": "5.0.0",
+    "remark-preset-lint-arcticicestudio": "0.1.0"
+  }
 }

src/README.md

@@ -0,0 +1,67 @@
+<p align="center"><img src="https://rawgit.com/arcticicestudio/styleguide-markdown/develop/assets/styleguide-markdown-banner-typography.svg"/></p>
+
+<p align="center"><img src="https://assets-cdn.github.com/favicon.ico" width=24 height=24/> <a href="https://github.com/arcticicestudio/styleguide-markdown/releases/latest"><img src="https://img.shields.io/github/release/arcticicestudio/styleguide-markdown.svg?style=flat-square"/></a></p>
+
+<p align="center"><img src="https://www.npmjs.com/static/images/touch-icons/favicon-32x32.png" width=24 height=24/> <a href="https://www.npmjs.com/package/remark-preset-lint-arcticicestudio"><img src="https://img.shields.io/npm/v/remark-preset-lint-arcticicestudio.svg?style=flat-square&label=remark-preset-lint-arcticicestudio"/></a></p>
+
+<p align="center"><a href="https://github.com/arcticicestudio/styleguide-markdown/blob/develop/CHANGELOG.md"><img src="https://img.shields.io/badge/Changelog----5E81AC.svg?style=flat-square"/></a></p>
+
+<p align="center"><img src="https://circleci.com/favicon.ico" width=24 height=24/> <a href="https://circleci.com/gh/arcticicestudio/styleguide-markdown"><img src="https://img.shields.io/circleci/project/github/arcticicestudio/styleguide-markdown/develop.svg?style=flat-square"/></a></p>
+
+<p align="center">The Arctic Ice Studio Markdown Code Style.</p>
+
+---
+
+<p align="center"><img src="https://cdn.rawgit.com/arcticicestudio/styleguide-markdown/develop/assets/styleguide-markdown-banner-typography-badge.svg" width="40%" /></p>
+
+Every major open source project has its own style guide, a set of standards and conventions for the writing and design of code, documentations and assets. It is much easier to understand a large codebase when all the code in it is in a consistent style.
+
+A style guide establishes and enforces style to improve the intelligibility and communication within the project community. It ensures consistency and enforces best practice in usage and language composition.
+
+### Getting Started
+
+This style guide provides the [comprehensive base rule set][rules] with support for [GitHub Flavored Markdown][gfm] which is based on the [CommonMark][commonmark] specification. It includes rules for all document elements like e.g. [code blocks][rules-code-blocks], [headings][rules-headings] or [lists][rules-lists], defines [naming conventions][rules-naming-conventions] and best practices for [whitespaces][rules-whitespaces], [Raw HTML][rules-raw-html], [emphasizing][rules-emphasis] and [strings][rules-strings].
+
+The development chapters contain information about the [requirements][dev-requirements] and [how to build][dev-building] this style guide documentation.
+
+To make sure your code matches this style guide use the official [remark-preset-lint-arcticicestudio][remark-preset-lint-arcticicestudio-ghio] code linter preset for [remark-lint][remark-lint-gh], a plugin for [remark][].
+
+### Contributing
+
+Read the [contributing guide][dev-contributing] to learn about the development process and how to propose [enhancement suggestions][dev-contributing-enhancements] and [report bugs][dev-contributing-bug-reports], how to [submit pull requests][dev-contributing-pr] and the project's [styleguides][dev-contributing-styleguides], [branch organization][dev-contributing-branch-org] and [versioning][dev-contributing-versioning] model.
+
+The guide also includes information about [minimal, complete, and verifiable examples][dev-contributing-mcve] and other ways to contribute to the project like [improving existing issues][dev-contributing-other-improve-issues] and [giving feedback on issues and pull requests][dev-contributing-other-feedback].
+
+<p align="center"><img src="https://cdn.rawgit.com/arcticicestudio/nord/develop/assets/banner-footer-mountains.svg" /></p>
+
+<p align="center">Copyright &copy; 2018-present Arctic Ice Studio & Sven Greb</p>
+
+<p align="center"><a href="https://github.com/arcticicestudio/styleguide-markdown/blob/develop/LICENSE.md"><img src="https://img.shields.io/badge/License-MIT-5E81AC.svg?style=flat-square"/></a></p>
+
+[dev-building]: development/building.md
+[dev-contributing]: development/contributing.md
+[dev-contributing-branch-org]: development/contributing.md#branch-organization
+[dev-contributing-bug-reports]: development/contributing.md#bug-reports
+[dev-contributing-enhancements]: development/contributing.md#enhancement-suggestions
+[dev-contributing-mcve]: development/contributing.md#mcve
+[dev-contributing-other-feedback]: development/contributing.md#give-feedback-on-issues-and-pull-requests
+[dev-contributing-other-improve-issues]: development/contributing.md#improve-issues
+[dev-contributing-pr]: development/contributing.md#pull-requests
+[dev-contributing-styleguides]: development/contributing.md#styleguides
+[dev-contributing-versioning]: development/contributing.md#versioning
+[dev-requirements]: development/requirements.md
+[rules]: rules/index.md
+[rules-code-blocks]: rules/code.md#blocks
+[rules-emphasis]: rules/emphasis.md
+[rules-headings]: rules/headings.md
+[rules-lists]: rules/lists.md
+[rules-naming-conventions]: rules/naming-conventions.md
+[rules-raw-html]: rules/raw-html.md
+[rules-strings]: rules/strings.md
+[rules-whitespaces]: rules/whitespaces.md
+
+[commonmark]: http://commonmark.org
+[gfm]: https://github.github.com/gfm
+[remark]: https://remark.js.org
+[remark-lint-gh]: https://github.com/remarkjs/remark-lint
+[remark-preset-lint-arcticicestudio-ghio]: https://arcticicestudio.github.io/remark-preset-lint-arcticicestudio