Skip to content

Commit

Permalink
initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
wooorm committed Nov 3, 2018
0 parents commit e7b9d83
Show file tree
Hide file tree
Showing 5 changed files with 272 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.DS_Store
*.log
node_modules/
74 changes: 74 additions & 0 deletions code-of-conduct.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# 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, nationality, personal appearance, race, religion, or sexual identity
and orientation.

## Our Standards

Examples of behaviour 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 behaviour by participants include:

* The use of sexualised 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
behaviour and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behaviour.

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 behaviours 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 behaviour may be
reported by contacting the project team at [email protected]. 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>.

[homepage]: https://www.contributor-covenant.org
48 changes: 48 additions & 0 deletions contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Contributing

> This project has a [Code of Conduct][coc].
> By interacting with this repository, organisation, or community you agree to
> abide by its terms.
Hi! 👋
Exciting that you’re interested in contributing!
Take a moment to read the following guidelines.
Thanks for contributing to **[remark][]**! 👏👌✨

Before anything else: people involved with this project often do so for fun,
next to their day job: you are not entitled to free customer service.

For questions, please [join the community on spectrum][chat].

## Contributions

Ensure your pull request adheres to the following guidelines:

* **The project should’ve existed at least 30 days before submitting**.
This is to give it some time to mature and ensure it’s not just a
publish-and-forget type of project
* Use the following format: `* [package](link)\n — description`
* Descriptions short and simple, but descriptive.
Start the description with a lower-case letter, end without a
full-stop/period
* If you submit a project that is similar to an existing project in the list,
argue how it’s better
* Suggested packages should be tested and documented
* Make an individual pull request for each suggestion
* New categories or improvements to the existing categorisation are welcome,
but should be done in a separate pull request

Thank you for your suggestion!

## Resources

* [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
* [Making your first contribution](https://medium.com/@vadimdemedes/making-your-first-contribution-de6576ddb190)
* [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
* [GitHub Help](https://help.github.com)

[coc]: code-of-conduct.md

[chat]: https://spectrum.chat/unified/remark

[remark]: https://github.com/remarkjs/remark
27 changes: 27 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
{
"name": "awesome",
"private": true,
"version": "0.0.0",
"description": "Curated list of awesome remark resources",
"license": "CC-BY-4.0",
"keywords": [],
"repository": "remarkjs/awesome",
"bugs": "https://github.com/remarkjs/awesome/issues",
"author": "Titus Wormer <[email protected]> (wooorm.com)",
"contributors": [
"Titus Wormer <[email protected]> (wooorm.com)"
],
"devDependencies": {
"remark-cli": "^6.0.0",
"remark-preset-wooorm": "^4.0.0"
},
"scripts": {
"format": "remark . -qfo",
"test": "npm run format"
},
"remarkConfig": {
"plugins": [
"preset-wooorm"
]
}
}
120 changes: 120 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
# awesome remark [![awesome][awesome-badge]][awesome]

A curated list of awesome [remark][] (a markdown processor and a [unified][]
project) resources.

## Official

* [remark][]
— repository
* [remark.js.org][homepage]
— website
* [remark-parse][]
— markdown parser
* [remark-stringify][]
— markdown generator
* [remark-cli][]
— command line interface
* [mdast][]
— abstract syntax tree specification
* [unified][]
— ecosystem
* [unified.js.org][ecosystem-homepage]
— ecosystem website

## Plugins

* [remark-rehype](https://github.com/remarkjs/remark-rehype)
— integrate with the [rehype][] ecosystem
* [remark-retext](https://github.com/remarkjs/remark-retext)
— integrate with the [retext][] ecosystem
* [remark-lint](https://github.com/remarkjs/remark-lint)
— markdown code-style linter
* [remark-man](https://github.com/remarkjs/remark-man)
— generate man pages
* [remark-toc](https://github.com/remarkjs/remark-toc)
— add a tables of contents
* [remark-github](https://github.com/remarkjs/remark-github)
— support GitHub references like issues, PRs, and comments
* [remark-math](https://github.com/Rokt33r/remark-math)
— support math
* [remark-frontmatter](https://github.com/remarkjs/remark-frontmatter)
— support YAML/TOML/more frontmatter
* [remark-license](https://github.com/remarkjs/remark-license)
— add a license section
* [remark-git-contributors](https://github.com/vweevers/remark-git-contributors)
— add a table with git contributors

[Find more plugins »](https://github.com/remarkjs/remark/blob/master/doc/plugins.md#list-of-plugins)

## Built on remark

* [mdx](https://github.com/mdx-js/mdx)
— markdown combined with JSX
* [react-markdown](https://github.com/rexxars/react-markdown)
— render markdown as React components
* [prettier](https://github.com/prettier/prettier)
— opinionated code formatter
* [gatsby](https://github.com/gatsbyjs/gatsby)
— blazing fast, modern apps and websites with React
* [netlify-cms](https://github.com/netlify/netlify-cms)
— CMS for static site generators
* [docz](https://github.com/pedronauck/docz)
— document your design system
* [postcss-markdown](https://github.com/gucong3000/postcss-markdown)
— process CSS in markdown
* [eslint-plugin-markdown](https://github.com/eslint/eslint-plugin-markdown)
— lint JavaScript in markdown
* [documentation.js](https://github.com/documentationjs/documentation)
— documentation system for modern JavaScript
* [x0](https://github.com/c8r/x0)
— document & develop React components without breaking a sweat

## Built with remark

* [freeCodeCamp](https://github.com/freeCodeCamp/freeCodeCamp)
— learn to code for free
* [Node.js](https://github.com/nodejs/node)
— Node.js JavaScript runtime
* [storybook](https://github.com/storybooks/storybook)
— interactive UI component dev & test
* [rxjs](https://github.com/ReactiveX/rxjs)
— Reactive Extensions For JavaScript
* [WebFundamentals](https://github.com/google/WebFundamentals) by [Google](https://opensource.google.com)
— best practices for modern web development
* [stylelint](https://github.com/stylelint/stylelint)
— mighty, modern style linter
* [opensource.guide](https://github.com/github/opensource.guide)
— community guides for open source creators
* [debugger.html](https://github.com/devtools-html/debugger.html) by [Mozilla](https://www.mozilla.org)
— Firefox debugger
* [regl](https://github.com/regl-project/regl)
— functional WebGL
* [cssnano](https://github.com/cssnano/cssnano)
— modular minifier built on top of PostCSS

<!-- Definitions. -->

[awesome-badge]: https://awesome.re/badge.svg

[awesome]: https://awesome.re

[unified]: https://github.com/unifiedjs/unified

[mdast]: https://github.com/syntax-tree/mdast

[homepage]: https://remark.js.org

[ecosystem-homepage]: https://unified.js.org

[remark]: https://github.com/remarkjs/remark

[remark-parse]: https://github.com/remarkjs/remark/tree/master/packages/remark-parse

[remark-stringify]: https://github.com/remarkjs/remark/tree/master/packages/remark-stringify

[remark-cli]: https://github.com/remarkjs/remark/tree/master/packages/remark-cli

[rehype]: https://github.com/rehypejs/rehype

[retext]: https://github.com/retextjs/retext

0 comments on commit e7b9d83

Please sign in to comment.