Many developers have profiles on Dev.to, it would be nice if they can also showcase their Dev.to profiles.

GitHub provides an option to initialise a README file while creating a repository. For this, it copies the same content from the Description into the README.

Now if someone wrote some markdown, expecting it to work, it would work in the README file but the Description is all rendered as plain text. Can markdown be enabled for repository descriptions too? That would make life a bit easier.

N

I have some notes that I'm hosting locally with grip for easy access. In these notes I have some .sh files linked. If I click the links in vscode it opens them up and displays them as I originally wrote them.

The only issue with grip is that when I open them, they have no whitespace or newlines where the original scripts have it. It's basically all one long, wrapped line.

Possi

Refer to:

1. commit-message-guidelines - robertpainsi
2. Follow these git commit message guidelines - theserverside
3. [Writing good commit messages](https://github.com/erlang/otp/wiki/writing-good-commit

There should be a linter, after the spec in the main readme is filled out. The linter will most likely use remark and remark-lint. This is the planning issue for the linter. Please subscribe here, and open new issues for tangential questions about Standard Readme.

hi there, in my package.json I have

... 
"build:utils": "jsdoc2md --files ./resources/assets/jsx/app/utils/*.ts* --configure ./jsdoc2md.json > ./resources/assets/jsx/docs/utils.md",

if I run by shell (MacOS, jsdoc2md v5.0.0)

$ jsdoc2md --files ./resources/assets/jsx/app/utils/*.ts* --configure ./jsdoc2md.json > ./resources/assets/jsx/docs/utils.md

all works fine,

I am creating a custom TOC to fix #104 for me; however, it's not that easy.

var toc = require('markdown-toc');
var md = '# heading\n## heading 2\n### heading 3';
var result = toc(md); // links are incorrect in the toc for Angular

var correct_toc = [];
result.json.forEach(function(h) {
    // fixed h.content
    correct_toc.push(new_h);
}

var toc_md = toc.bullets(corre

Hi,

We would like to ask for a review of the docs of Schleuder, a GPG-enabled mailing list manager with resending capabilities, and related projects:

• https://0xacab.org/schleuder/schleuder
• https://0xacab.org/schleuder/schleuder-cli
• https://0xacab.org/schleuder/schleuder-web
• https://0xacab.org/schleuder/schleuder-website

Thanks in advance, and for your work.

Cheers,
Georg

Perhaps you could add a word in the README file for saying that asciidoctor format is supported as well? (And what else?)

Also, apparently there’s no support for recurse option in awesome_bot but I was able to make it work with find -name "*.adoc" -print0 | xargs -0 awesome_bot in the .travis.yml file. Perhaps this would also deserve mention in the doc.

Seems now we don't need this addon because most of the feature provided by stroybook-readme are implemented at storybook

https://medium.com/storybookjs/storybook-docspage-e185bc3622bf

A keepComments option is processed but is not documented.

Should we add it in the doc or remove it in the code?

The current editable template is a great start. It's right there and you just have to edit it, like you do with your README.md in your editor. (That's a little nerdy, but not elitist, so i would keep that design. I think programmers love it!) You don't have to install anything and have a preview next to it.

We should extend it in a way so it still feels this lightwight.

I like the idea to ha

<!-- EXAMPLE[./example.js] --> will output the file in a syntax code block, and replaces require('./') with require('the-package-name') - useful for including example code files

<!-- CODE[./input.js] --> will output the file in a syntax highlighted code block - useful for including code files

<!-- SOURCE[./output.md] --> will output the file as is, no code block wrapper - useful for in

The argument is described in https://doc.rust-lang.org/rustdoc/documentation-tests.html#attributes

This snipped is not recognized as rust code.

//! ```rust,compile_fail
//! use tabled::Tabled;
//!
//! #[derive(Tabled)]
//! struct SomeType {
//! field1: SomeOtherType,
//! }
//! 
//! struct SomeOtherType;
//! ```

The correct behavior should be the same as no_run, `ignor