README
The Arctic Ice Studio Markdown Style Guide rules as remark-lint configuration preset
Getting Started
The documentation provides chapters to learn about the requirements, the installation and how to use the package. You can learn how to build the project and run the tests in the development chapters.
The package includes support for all official core rules. It also includes supports the “frontmatter” Markdown extension for YAML and TOML via remark-frontmatter.
Quick Start
Installation
Add the package as development dependency to your project:
npm install --save-dev remark-preset-lint-arcticicestudio
remark-lint can be used to process markdown using plugins with the CLI for remark. Therefore this package depends on the remark-cli package defined as peer dependency.
Run npm install from within the project root to bootstrap the project and install the development- and runtime dependencies. The peer dependency can now be easily installed using npm 5+ with npx:
npx install-peerdeps --dev remark-preset-lint-arcticicestudio
Please read the documentation on how to install the peer dependencies if using npm < 5.
Usage
This remark-lint configuration preset can be used by adding it to the plugins within the remark-lint configuration file of your project.
Add remark-preset-lint-arcticicestudio to the plugins array in your .remarkrc.js or .remarkrc file:
module.exports = {
plugins: ["remark-preset-lint-arcticicestudio"]
};
Contributing
Read the contributing guide to learn about the development process and how to propose enhancement suggestions and report bugs, how to submit pull requests and the project's styleguides, branch organization and versioning model.
The guide also includes information about minimal, complete, and verifiable examples and other ways to contribute to the project like improving existing issues and giving feedback on issues and pull requests.
Copyright © 2018-present Arctic Ice Studio & Sven Greb
