Skip to content
#

readme-template

Here are 87 public repositories matching this topic...

davidak
davidak commented Oct 15, 2018

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

balupton
balupton commented Sep 16, 2015

<!-- 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

This is an attempt to develop a default readme file for Magento extensions. It should be included in the Magento extension directory under e.g. app/code/community/Company/ExampleExtension/readme.markdown. The markdown syntax (http://daringfireball.net/projects/markdown/syntax) is used for better and consistent formatting. Please join the discussion - open issues and send pull requests! Thanks to Josh Pratt for the idea: http://prattski.com/2012/08/30/magento-dev-best-practices-module-readme-files/

  • Updated Dec 22, 2018
gregswindle
gregswindle commented Sep 30, 2017

💡 TIP: Select the ↖︎⎾ Preview ⏋ Tab above help read these instructions.

1. Issue type

  • Feature: I'm requesting a product enhancement.

2. User story summary

As a consumer or contributor,
I want interactive documentation with [RunKit][runkit-url]
In order to learn and try using and contributing to generator-community.

3. Acceptance criteria

  • 1. Docume

Improve this page

Add a description, image, and links to the readme-template topic page so that developers can more easily learn about it.

Curate this topic

Add this topic to your repo

To associate your repository with the readme-template topic, visit your repo's landing page and select "manage topics."

Learn more

You can’t perform that action at this time.