markdownlint-cli
markdown-here
Our great sponsors
markdownlint-cli | markdown-here | |
---|---|---|
3 | 73 | |
782 | 59,476 | |
- | - | |
8.2 | 0.0 | |
29 days ago | over 1 year ago | |
JavaScript | JavaScript | |
MIT License | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
markdownlint-cli
-
My setup for publishing to Dev.to using github
repos: - repo: https://github.com/pre-commit/pre-commit-hooks rev: v2.3.0 hooks: - id: check-yaml - id: end-of-file-fixer - id: trailing-whitespace - repo: https://github.com/Yelp/detect-secrets rev: v1.4.0 hooks: - id: detect-secrets - repo: https://github.com/igorshubovych/markdownlint-cli rev: v0.33.0 hooks: - id: markdownlint args: ["--disable=MD013"] # this removes line length warnings
-
Recommend Visual Studio Code extensions along with your code
We saw how we can utilize extensions.json to recommend VS Code extensions with code to developers. But why do we want to do this? The purpose is making life of developers/contributors easier. For example, I use indent-rainbow to make indents more readable. Let's say that you are using markdownlint-cli with your CI setup then you may consider adding markdownlint to extensions.json. This extension runs same rules with markdownlint-cli and immediately detects linting errors while you typing. This allows contributors to detect linting errors before pushing anything and waiting CI pipeline (linting) to fail. This shortens the loop significantly. So if you (as a repository/codebase maintainer) think that a particular VS Code extension helps contributors then add it. But don't recommend anything satisfying your personal choices like color theme, icon set, etc. They won't help other developers much.
-
TIL: Use pre-commit hook - the framework
$ cd til $ pre-commit autoupdate Updating https://github.com/pre-commit/pre-commit-hooks ... [INFO] Initializing environment for https://github.com/pre-commit/pre-commit-hooks. updating v2.3.0 -> v4.0.1. Updating https://github.com/igorshubovych/markdownlint-cli ... already up to date.
markdown-here
-
100+ FREE Resources Every Web Developer Must Try
Markdown Cheat Sheet: Markdown syntax guide for creating rich text formatting.
-
How to create a good README.md file
# Heading 1 ## Heading 2 ### Heading 3 Emphasis, aka italics, with *asterisks* or _underscores_. Strong emphasis, aka bold, with **asterisks** or __underscores__. Combined emphasis with **asterisks and _underscores_**. 1. First ordered list item 2. Another item ⋅⋅* Unordered sub-list. 1. Actual numbers don't matter, just that it's a number ⋅⋅1. Ordered sub-list 4. And another item. [I'm an inline-style link](https://www.google.com) [I'm an inline-style link with title](https://www.google.com "Google's Homepage") ![descriptive alt text](https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png "Logo Title Text 1")
- What is the point of this feature
-
No Markdown support in Google Drive after all these years
It's definitely a workaround, but I use a Chrome extension to work around this a bit. I use "Markdown Here" to add a "turn Markdown text to formatted text" button to my Chrome bar:
https://markdown-here.com/
And then I use it on plain Markdown text in a GMail compose window. The rich formatted output it produces can then be pasted into a Google Doc, and it comes out really nicely, including support for headers, sub-headers, links, code blocks, and the rest. The main issue is that this is a one-way process, but so long as you keep the .md source somewhere else, lets you share a richly-formatted doc with others for final commenting/editing/etc.
-
Which one for “semi-formal to casual” in south dakota?
Here is a reference guide for the basic syntax of Markdown. Experiment and enjoy!
-
Newbie question
Means I made changes to the post formatting using Markdown https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
-
School Project looking for Review
markdown syntax Can be used to format your read me.
-
Best Practices for Writing on DEV: Formatting
Proper formatting is key to ensure that your post is readable, helpful, and polished. Our post editor uses Markdown and Jekyll Front Matter to format posts.
-
Boost Your JavaScript with JSDoc Typing
You can also use more complex Markdown features like lists and tables. Check out the [Markdown Cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) from Adam Pritchard for more information. ### Other JSDoc tags 📚 There are a few other JSDoc tags that you may find useful: - `@function` or `@func`: Documents a function or method. - `@class`: Documents a class constructor. - `@constructor`: Indicates that a function is a constructor for a class. - `@extends` or `@augments`: Indicates that a class or type extends another class or type. - `@implements`: Indicates that a class or type implements an interface. - `@namespace`: Groups related items, such as functions, classes, or types, under a common namespace. - `@memberof`: Specifies that an item belongs to a class, namespace, or module. - `@ignore`: Tells JSDoc to exclude an item from the generated documentation. - `@deprecated`: Marks a function, class, or property as deprecated, indicating it should no longer be used. - `@since`: Documents the version when an item was introduced. And many more. You can find a full list of JSDoc tags [here](https://jsdoc.app/). Ok ok, enough of the theory. Let's see how we can use JSDoc in practice. ![Reality Check Meme](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/polug716a3hs9lgwr8tf.gif) ## Using JSDoc in practice 🏄♂️ There are a few challenges when starting to use JSDoc in your project. So this section will focus on these challenges and how you can overcome them. ### How to get the most out of JSDoc In this post I'm going to stick with VSCode. If you're using another editor, you can still follow along, but you might have to look up how to configure things in your editor. VSCode has built-in support for JSDoc. This means that you can get a lot of the JSDoc benefits without having to install any additional extensions. But there are a few things that you can do to get even more out of JSDoc. Enabling the checkJs option in your `jsconfig.json` file will make the editor display errors for type mismatches, even in JavaScript files. Place it in the root of your project or in the folder where you want to enable type checking. This file can look like this: ```json { "compilerOptions": { "checkJs": true, } }
-
In my Eras era. 💅
Reddit uses Markdown, it's a pretty ubiquitous markup for formatting text online. You'll find it's used in a lot of places. https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
What are some alternatives?
prettier - Prettier is an opinionated code formatter.
notable - The Markdown-based note-taking app that doesn't suck.
pre-commit-hooks - git pre-commit hooks that work with http://pre-commit.com/
termux-widget - Termux add-on app which adds shortcuts to commands on the home screen.
pre-commit - A framework for managing and maintaining multi-language pre-commit hooks.
simple-icons - SVG icons for popular brands
pre-commit-hooks - Some out-of-the-box hooks for pre-commit
react-syntax-highlighter - syntax highlighting component for react with prismjs or highlightjs ast using inline styles
check-jsonschema - A CLI and set of pre-commit hooks for jsonschema validation with built-in support for GitHub Workflows, Renovate, Azure Pipelines, and more!
Hugo - The world’s fastest framework for building websites.
devto-github-template - Example repository setup for synchronizing markdown files as dev.to articles, using assets hosted on GitHub.
shields - Concise, consistent, and legible badges in SVG and raster format