mirror of
https://github.com/BubuAnabelas/awesome-markdown.git
synced 2024-10-01 01:06:15 -04:00
Use remark for linting and style checking.
This commit is contained in:
BubuAnabelas
parent
13372bbf75
commit
063711f108
31
.remarkrc
Normal file
31
.remarkrc
Normal file
@ -0,0 +1,31 @@
|
||||
{
|
||||
"plugins": [
|
||||
["remark-message-control", {"name": "lint"}],
|
||||
"lint",
|
||||
["lint-emphasis-marker", "_"],
|
||||
["lint-code-block-style", "indented"],
|
||||
["lint-fenced-code-marker", "`"],
|
||||
"lint-final-newline",
|
||||
["lint-heading-style", "atx"],
|
||||
["lint-linebreak-style", "unix"],
|
||||
["lint-strong-marker", "*"],
|
||||
"lint-no-blockquote-without-marker",
|
||||
"lint-no-consecutive-blank-lines",
|
||||
"lint-no-duplicate-headings-in-section",
|
||||
"lint-no-emphasis-as-heading",
|
||||
"lint-no-empty-url",
|
||||
"lint-no-heading-content-indent",
|
||||
"lint-no-heading-like-paragraph",
|
||||
"lint-no-heading-punctuation",
|
||||
"lint-no-inline-padding",
|
||||
["lint-no-missing-blank-lines", {"exceptTightLists": true}],
|
||||
"lint-no-multiple-toplevel-headings",
|
||||
"lint-no-undefined-references",
|
||||
"lint-no-unused-definitions",
|
||||
["lint-ordered-list-marker-style", "."],
|
||||
"lint-ordered-list-marker-value",
|
||||
["lint-rule-style", "---"],
|
||||
["lint-unordered-list-marker-style", "-"],
|
||||
"remark-lint-alphabetize-lists"
|
||||
]
|
||||
}
|
||||
@ -6,6 +6,7 @@ before_script:
|
||||
- gem install danger
|
||||
script:
|
||||
- awesome_bot README.md --allow-dupe --allow-redirect
|
||||
- remark -f --no-stdout README.md
|
||||
- danger
|
||||
notifications:
|
||||
email: false
|
||||
|
||||
27
README.md
27
README.md
@ -1,13 +1,16 @@
|
||||
# Awesome Markdown [](https://github.com/sindresorhus/awesome)
|
||||
|
||||
|
||||
<img src="https://upload.wikimedia.org/wikipedia/commons/4/48/Markdown-mark.svg" align="right" width="208">
|
||||
|
||||
> A curated list of delightful Markdown stuff.
|
||||
|
||||
Markdown is a markup language created by John Gruber in collaboration with Aaron Swartz. It was designed to be easily converted to HTML and has been extended into different types of implementations.
|
||||
|
||||
*Please read the [contribution guidelines](contributing.md) before contributing.*
|
||||
<!--lint disable no-emphasis-as-heading-->
|
||||
|
||||
_Please read the [contribution guidelines](contributing.md) before contributing._
|
||||
|
||||
<!--lint enable no-emphasis-as-heading-->
|
||||
|
||||
:gem: means **really _awesome/useful_**.<br />
|
||||
<img src="https://maxcdn.icons8.com/Color/PNG/24/Maps/globe-24.png" title="Globe" width="24"> means that **it's _webapp/webservice_**.<br />
|
||||
@ -17,6 +20,10 @@ Markdown is a markup language created by John Gruber in collaboration with Aaron
|
||||
<img src="https://maxcdn.icons8.com/Color/PNG/24/Operating_Systems/linux-24.png" title="Linux" width="24"> means that **runs on _Linux_**.<br />
|
||||
<img src="https://maxcdn.icons8.com/Color/PNG/24/Operating_Systems/windows8_copyrighted-24.png" title="Windows8" width="24"> means that **runs on _Windows_**.<br />
|
||||
|
||||
<!--lint disable no-paragraph-content-indent-->
|
||||
|
||||
<!--lint disable alphabetize-lists-->
|
||||
|
||||
## Contents
|
||||
|
||||
- [CMS / Blogs](#cms--blogs)
|
||||
@ -41,7 +48,12 @@ Markdown is a markup language created by John Gruber in collaboration with Aaron
|
||||
|
||||
---
|
||||
|
||||
<!--lint enable alphabetize-lists-->
|
||||
|
||||
<!--lint enable no-paragraph-content-indent-->
|
||||
|
||||
## CMS / Blogs
|
||||
|
||||
> CMS or Blogs which support Markdown by default.
|
||||
|
||||
- [Ghost](https://blog.ghost.org/markdown/) - Publishing platform for professional bloggers.
|
||||
@ -51,6 +63,7 @@ Markdown is a markup language created by John Gruber in collaboration with Aaron
|
||||
- [Svbtle](https://svbtle.com/) - Blogging platform designed to help you think.
|
||||
|
||||
## Libraries
|
||||
|
||||
> Libraries for rendering Markdown documents.
|
||||
|
||||
### C
|
||||
@ -67,9 +80,9 @@ Markdown is a markup language created by John Gruber in collaboration with Aaron
|
||||
|
||||
### JavaScript
|
||||
|
||||
- [marked](https://github.com/chjj/marked) - Full-featured Markdown parser and compiler, written in JavaScript. Built for speed.
|
||||
- [markdown-it](https://github.com/markdown-it/markdown-it) - Markdown parser, done right. 100% CommonMark support, extensions, syntax plugins & high speed.
|
||||
- [markdown-js](https://github.com/evilstreak/markdown-js) - Yet another Markdown parser, this time for JavaScript.
|
||||
- [marked](https://github.com/chjj/marked) - Full-featured Markdown parser and compiler, written in JavaScript. Built for speed.
|
||||
- [Showdown](https://github.com/showdownjs/showdown) - Showdown is a JavaScript Markdown to HTML converter, based on the original works by John Gruber.
|
||||
- [Snarkdown](https://github.com/developit/snarkdown) - Snarkdown is a dead simple 1kb Markdown parser.
|
||||
|
||||
@ -101,10 +114,10 @@ Markdown is a markup language created by John Gruber in collaboration with Aaron
|
||||
|
||||
- [csvtomd](https://github.com/mplewis/csvtomd) - Convert your CSV files into Markdown tables. <img src="https://maxcdn.icons8.com/Android_L/PNG/24/Operating_Systems/mac_os-24.png" title="Apple" width="24"> <img src="https://maxcdn.icons8.com/Color/PNG/24/Operating_Systems/linux-24.png" title="Linux" width="24"> <img src="https://maxcdn.icons8.com/Color/PNG/24/Operating_Systems/windows8_copyrighted-24.png" title="Windows8" width="24">
|
||||
- [HTML To Markdown for PHP](https://github.com/thephpleague/html-to-markdown) - Convert HTML to Markdown with PHP.
|
||||
- [to-markdown](https://github.com/domchristie/to-markdown) - HTML to Markdown converter written in JavaScript.
|
||||
- [markdown-pdf](https://github.com/alanshaw/markdown-pdf) - Markdown to PDF converter.
|
||||
- [Markdown to PDF](http://www.markdowntopdf.com/) - Simple and useful website for converting Markdown to PDF. <img src="https://maxcdn.icons8.com/Color/PNG/24/Maps/globe-24.png" title="Globe" width="24">
|
||||
- [Pandoc](http://pandoc.org/) - Universal document converter. <img src="https://maxcdn.icons8.com/Android_L/PNG/24/Operating_Systems/mac_os-24.png" title="Apple" width="24"> <img src="https://maxcdn.icons8.com/Color/PNG/24/Operating_Systems/linux-24.png" title="Linux" width="24"> <img src="https://maxcdn.icons8.com/Color/PNG/24/Operating_Systems/windows8_copyrighted-24.png" title="Windows8" width="24">
|
||||
- [to-markdown](https://github.com/domchristie/to-markdown) - HTML to Markdown converter written in JavaScript.
|
||||
- [Torsimany](https://github.com/PolBaladas/torsimany) - Translate format-independent JSON to stylish, human-readable Markdown. <img src="https://maxcdn.icons8.com/Android_L/PNG/24/Operating_Systems/mac_os-24.png" title="Apple" width="24"> <img src="https://maxcdn.icons8.com/Color/PNG/24/Operating_Systems/linux-24.png" title="Linux" width="24"> <img src="https://maxcdn.icons8.com/Color/PNG/24/Operating_Systems/windows8_copyrighted-24.png" title="Windows8" width="24">
|
||||
- [yamp](https://github.com/angrykoala/yamp) - Wasy-to-use cli toolbox for markdown-related task. <img src="https://maxcdn.icons8.com/Android_L/PNG/24/Operating_Systems/mac_os-24.png" title="Apple" width="24"> <img src="https://maxcdn.icons8.com/Color/PNG/24/Operating_Systems/linux-24.png" title="Linux" width="24"> <img src="https://maxcdn.icons8.com/Color/PNG/24/Operating_Systems/windows8_copyrighted-24.png" title="Windows8" width="24">
|
||||
|
||||
@ -135,11 +148,11 @@ Markdown is a markup language created by John Gruber in collaboration with Aaron
|
||||
|
||||
- [Classeur](http://classeur.io/) - Classeur is a new platform to write simple notes as well as technical documents and blogs. <img src="https://maxcdn.icons8.com/Color/PNG/24/Maps/globe-24.png" title="Globe" width="24">
|
||||
- [Dillinger](http://dillinger.io/) - Dillinger is a cloud-enabled, mobile-ready, offline-storage, AngularJS powered HTML5 Markdown editor. <img src="https://maxcdn.icons8.com/Color/PNG/24/Maps/globe-24.png" title="Globe" width="24">
|
||||
- [GitDown](https://github.com/gajus/gitdown) – GitHub's Markdown preprocessor. :octocat:
|
||||
- [GitDown](https://github.com/gajus/gitdown) – GitHub's Markdown preprocessor. :octocat:
|
||||
- [HackMD](https://hackmd.io) - HackMD lets you create realtime collaborative Markdown notes on all platforms. <img src="https://maxcdn.icons8.com/Color/PNG/24/Maps/globe-24.png" title="Globe" width="24">
|
||||
- [Laverna](https://laverna.cc/) - Laverna is a JavaScript note taking application with Markdown editor and encryption support. :gem: _Markdown notes with encryption!_ <img src="https://maxcdn.icons8.com/Color/PNG/24/Maps/globe-24.png" title="Globe" width="24"> <img src="https://maxcdn.icons8.com/Android_L/PNG/24/Operating_Systems/mac_os-24.png" title="Apple" width="24"> <img src="https://maxcdn.icons8.com/Color/PNG/24/Operating_Systems/linux-24.png" title="Linux" width="24"> <img src="https://maxcdn.icons8.com/Color/PNG/24/Operating_Systems/windows8_copyrighted-24.png" title="Windows8" width="24">
|
||||
- [Markable.in](https://markable.in/) - Remarkable Markdown Editor. <img src="https://maxcdn.icons8.com/Color/PNG/24/Maps/globe-24.png" title="Globe" width="24">
|
||||
- [Markdown Tables Generator](http://www.tablesgenerator.com/markdown_tables) - Visual Markdown table builder with CSV importing support. <img src="https://maxcdn.icons8.com/Color/PNG/24/Maps/globe-24.png" title="Globe" width="24">
|
||||
- [Laverna](https://laverna.cc/) - Laverna is a JavaScript note taking application with Markdown editor and encryption support. :gem: _Markdown notes with encryption!_ <img src="https://maxcdn.icons8.com/Color/PNG/24/Maps/globe-24.png" title="Globe" width="24"> <img src="https://maxcdn.icons8.com/Android_L/PNG/24/Operating_Systems/mac_os-24.png" title="Apple" width="24"> <img src="https://maxcdn.icons8.com/Color/PNG/24/Operating_Systems/linux-24.png" title="Linux" width="24"> <img src="https://maxcdn.icons8.com/Color/PNG/24/Operating_Systems/windows8_copyrighted-24.png" title="Windows8" width="24">
|
||||
- [remark](http://remark.js.org/) - Markdown processor powered by plugins
|
||||
- [Socrates](http://socrates.io/) - Serveless realtime Markdown editor and viewer, etherpad-like. <img src="https://maxcdn.icons8.com/Color/PNG/24/Maps/globe-24.png" title="Globe" width="24">
|
||||
|
||||
@ -180,9 +193,9 @@ Markdown is a markup language created by John Gruber in collaboration with Aaron
|
||||
|
||||
> Useful links and tutorials.
|
||||
|
||||
- [GitHub's Mastering Markdown](https://guides.github.com/features/mastering-markdown/)
|
||||
- [how-to-markdown](https://github.com/workshopper/how-to-markdown) - This workshopper will teach you how to use Markdown.
|
||||
- [Interactive Markdown Tutorial](http://www.markdowntutorial.com/)
|
||||
- [GitHub's Mastering Markdown](https://guides.github.com/features/mastering-markdown/)
|
||||
- [Markdown Cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) :gem: _Where to look when you don't remember the syntax!_
|
||||
- [Markdown Guide](https://www.markdownguide.org) - A concise, barebones guide to Markdown.
|
||||
|
||||
|
||||
35
package.json
Normal file
35
package.json
Normal file
@ -0,0 +1,35 @@
|
||||
{
|
||||
"name": "awesome-markdown",
|
||||
"repository": "https://github.com/BubuAnabelas/awesome-markdown/",
|
||||
"author": "BubuAnabelas <BubuAnabelas@cryptolab.net>",
|
||||
"dependencies": {
|
||||
"remark-cli": "^4.0.0",
|
||||
"remark-lint": "^6.0.1",
|
||||
"remark-lint-alphabetize-lists": "^2.0.0",
|
||||
"remark-lint-code-block-style": "^1.0.1",
|
||||
"remark-lint-emphasis-marker": "^1.0.1",
|
||||
"remark-lint-fenced-code-marker": "^1.0.1",
|
||||
"remark-lint-final-newline": "^1.0.1",
|
||||
"remark-lint-heading-style": "^1.0.1",
|
||||
"remark-lint-linebreak-style": "^1.0.1",
|
||||
"remark-lint-no-blockquote-without-marker": "^2.0.1",
|
||||
"remark-lint-no-consecutive-blank-lines": "^1.0.1",
|
||||
"remark-lint-no-duplicate-headings-in-section": "^1.0.1",
|
||||
"remark-lint-no-emphasis-as-heading": "^1.0.1",
|
||||
"remark-lint-no-empty-url": "^1.0.2",
|
||||
"remark-lint-no-heading-content-indent": "^1.0.1",
|
||||
"remark-lint-no-heading-like-paragraph": "^1.0.1",
|
||||
"remark-lint-no-heading-punctuation": "^1.0.1",
|
||||
"remark-lint-no-inline-padding": "^1.0.1",
|
||||
"remark-lint-no-missing-blank-lines": "^1.0.1",
|
||||
"remark-lint-no-multiple-toplevel-headings": "^1.0.1",
|
||||
"remark-lint-no-undefined-references": "^1.0.1",
|
||||
"remark-lint-no-unused-definitions": "^1.0.1",
|
||||
"remark-lint-ordered-list-marker-style": "^1.0.1",
|
||||
"remark-lint-ordered-list-marker-value": "^1.0.1",
|
||||
"remark-lint-rule-style": "^1.0.1",
|
||||
"remark-lint-strong-marker": "^1.0.1",
|
||||
"remark-lint-unordered-list-marker-style": "^1.0.1",
|
||||
"remark-message-control": "^4.0.2"
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue
Block a user