chore: add documentation (#2)

CODE_OF_CONDUCT.md

@@ -0,0 +1,73 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+education, socio-economic status, nationality, personal appearance, race,
+religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at {{ TBD }}. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
+
+[homepage]: https://www.contributor-covenant.org

CONTRIBUTING.md

@@ -0,0 +1,94 @@
+# Contributing to QuickMark
+
+First off, thank you for considering contributing to QuickMark! Your contributions are what make this project better. Whether you're reporting bugs, adding new features, or improving documentation, we appreciate your help.
+
+## How to Contribute
+
+### Reporting Bugs
+
+If you find a bug, please open an issue and include as much detail as possible:
+
+- Steps to reproduce the issue
+- The expected behavior
+- The actual behavior
+- Screenshots or logs, if applicable
+- Your environment (OS, Rust version, etc.)
+
+### Suggesting Enhancements
+
+We welcome suggestions for improvements. Please open an issue and provide:
+
+- A clear and descriptive title
+- A detailed description of the proposed enhancement
+- Any relevant context or examples
+
+### Submitting Pull Requests
+
+If you'd like to contribute code to QuickMark, please follow these steps:
+
+1. **Fork the Repository**
+   - Click the "Fork" button at the top of this repository.
+
+2. **Clone Your Fork**
+
+   ```sh
+   git clone https://github.com/your-username/quickmark.git
+   cd quickmark
+   ```
+
+3. **Create a Branch**
+
+```sh
+git checkout -b feature-or-bugfix-description
+```
+
+4. **Make Changes**
+
+- implement your feature or bugfix.
+- Ensure your code follows the project’s coding standards.
+- Add or update tests as necessary.
+- Run tests to ensure everything works correctly.
+
+5. **Commit Changes**
+
+```sh
+git add .
+git commit -m "Description of changes"
+```
+
+6. **Push to Your Fork**
+
+```sh
+git push origin feature-or-bugfix-description
+```
+
+7. **Open a Pull Request**
+
+- Go to the original repository on GitHub.
+- Click on the "Pull Requests" tab and then the "New Pull Request" button.
+- Provide a clear title and description of your changes.
+
+## Code Style and Standards
+
+- Follow Rust’s standard formatting with rustfmt.
+- Write meaningful commit messages.
+- Ensure your code is well-documented.
+
+## Linting Rules
+
+QuickMark is in the early stages of porting rules from [markdownlint](https://github.com/markdownlint/markdownlint). If you're interested in helping with this effort:
+
+- Check the list of rules that need to be ported in the issues section.
+- Follow the guidelines in existing rule implementations.
+
+## Code of Conduct
+
+Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms.
+
+## Getting Help
+
+If you have any questions or need assistance, feel free to open an issue or contact the maintainers.
+
+## Thank You
+
+Thank you for your interest in contributing to QuickMark! We look forward to your contributions and appreciate your support in improving the project.

README.md

@@ -1 +1,48 @@
-# quickmark
+# QuickMark
+
+[![image](https://img.shields.io/badge/license-MIT-blue)](https://github.com/ekropotin/quickmark/blob/main/LICENSE)
+
+> **Notice:** This project is at super early stage of development. Expect frequent updates and breaking changes.
+
+An lightning-fast linter for Markdown/[CommonMark](https://commonmark.org/) files, written in Rust.
+
+QuickMark is not just another Markdown linter; it's a tool designed with the modern developer in mind. By prioritizing speed and integrating seamlessly with your development environment, QuickMark enhances your productivity and makes Markdown linting an effortless part of your workflow.
+
+QuickMark takes a lot of inspiration from Mark Harrison's [markdownlint](https://github.com/markdownlint/markdownlint) for Ruby. We love how thorough and reliable markdownlint is, and we're just getting started with porting its rules over to QuickMark. While the project is still in its early stages, our goal is to eventually bring all the markdownlint rules into QuickMark.
+
+## Key features
+
+- **Rust-Powered Speed**: Leveraging the power of Rust, QuickMark offers exceptional performance, making linting operations swift and efficient, even for large Markdown files.
+- **LSP Integration**: QuickMark integrates effortlessly with your favorite code editors through LSP, providing real-time feedback and linting suggestions directly within your editor.
+- **Customizable Rules**: Tailor the linting rules to fit your project's specific needs, ensuring that your Markdown files adhere to your preferred style and standards.
+
+## Getting Started
+
+### Installation
+
+At this point, the only way to get the binary is building it from the sources:
+
+```shell
+git clone git@github.com:ekropotin/quickmark.git
+cd quickmark
+cargo build --release
+```
+
+This command will generate the `quickmark` binary in the `./target/release` directory.
+
+### Usage
+
+Lint a single file:
+
+```shell
+quickmark /path/to/file.md
+```
+
+### Configuration
+
+TBD
+
+## Rules
+
+- **[MD001](docs/rules/md001.md)** *heading-increment* - Heading levels should only increment by one level at a time
+

docs/rules/md001.md

@@ -0,0 +1,37 @@
+# `MD001` - Heading levels should only increment by one level at a time
+
+Tags: `headings`
+
+Aliases: `heading-increment`
+
+This rule is triggered when you skip heading levels in a Markdown document, for
+example:
+
+```markdown
+# Heading 1
+
+### Heading 3
+
+We skipped out a 2nd level heading in this document
+```
+
+When using multiple heading levels, nested headings should increase by only one
+level at a time:
+
+```markdown
+# Heading 1
+
+## Heading 2
+
+### Heading 3
+
+#### Heading 4
+
+## Another Heading 2
+
+### Another Heading 3
+```
+
+Rationale: Headings represent the structure of a document and can be confusing
+when skipped - especially for accessibility scenarios. More information:
+<https://www.w3.org/WAI/tutorials/page-structure/headings/>.