This repository has been archived on 2023-08-20. You can view files and clone it, but cannot push or open issues or pull requests.
Go to file
Fabien Potencier c3230f0a97 minor #20896 [Console] Enhance MarkdownDescriptor (ogizanagi)
This PR was squashed before being merged into the 3.3-dev branch (closes #20896).

Discussion
----------

[Console] Enhance MarkdownDescriptor

| Q             | A
| ------------- | ---
| Branch?       | master
| Bug fix?      | yes
| New feature?  | yes
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | N/A
| License       | MIT
| Doc PR        | N/A

In order to add usefulness to this descriptor, this PR allows to jump to a command description by clicking on the command name on the application summary.

It's not a generic approach but IMHO a quick win that should work at least for Github flavoured markdown.

The markdown format should also avoid using `Application::getLongVersion` as the markdown document title, as it may contain tags (and unnecessary information using the framework).

Lastly, the markdown format is now cleaned from tags initially used for console output formatting and only keeps properly escaped ones.

Commits
-------

ef5b087b4f Do not output formatting tags
6896865bcc [Console] MarkdownDescriptor: Don't use getLongVersion
fc2395e237 [Console] MarkdownDescriptor: Link to commands anchors
2017-02-16 06:18:56 -08:00
.composer Drop hirak/prestissimo 2016-05-12 07:44:15 -05:00
.github Remove 3.1 from PR template 2017-02-04 19:24:41 +01:00
src/Symfony minor #20896 [Console] Enhance MarkdownDescriptor (ogizanagi) 2017-02-16 06:18:56 -08:00
.editorconfig Add EditorConfig File 2012-06-16 14:08:15 +02:00
.gitignore Add appveyor.yml for C.I. on Windows 2015-08-25 23:41:37 +02:00
.php_cs.dist Merge branch '2.7' into 2.8 2017-01-21 08:53:15 -08:00
.travis.yml [Process] Deprecate not inheriting env vars + compat related settings 2017-01-31 15:22:24 +01:00
CHANGELOG-3.0.md Merge branch '2.8' into 3.1 2016-08-05 10:37:39 +02:00
CHANGELOG-3.1.md updated CHANGELOG for 3.1.9 2017-01-12 12:43:31 -08:00
CHANGELOG-3.2.md updated CHANGELOG for 3.2.3 2017-02-06 14:15:13 +01:00
CONTRIBUTING.md Mention the community review guide 2016-12-18 22:02:35 +01:00
CONTRIBUTORS.md update CONTRIBUTORS for 2.7.24 2017-02-06 13:05:55 +01:00
LICENSE updated LICENSE year 2017-01-02 12:30:00 -08:00
README.md Merge branch '2.8' into 3.1 2016-12-23 17:43:44 +01:00
UPGRADE-3.0.md Merge branch '2.8' into 3.2 2017-01-31 22:49:23 +01:00
UPGRADE-3.1.md [Serializer] Remove AbstractObjectNormalizer::isAttributeToNormalize 2016-12-08 16:02:32 +01:00
UPGRADE-3.2.md [TwigBridge] Fix upgrade/changelog notes 2016-12-27 20:04:23 +01:00
UPGRADE-3.3.md feature #21283 [Form][FrameworkBundle] Move FormPass to the Form component (chalasr) 2017-02-16 05:34:28 -08:00
UPGRADE-4.0.md feature #21283 [Form][FrameworkBundle] Move FormPass to the Form component (chalasr) 2017-02-16 05:34:28 -08:00
appveyor.yml Merge branch '3.1' into 3.2 2017-01-03 12:28:32 +01:00
composer.json feature #21265 [DI] Implement PSR-11 (greg0ire) 2017-02-08 16:52:20 +01:00
phpunit Minor fixes found while ugrading the CI 2017-01-03 16:43:07 +01:00
phpunit.xml.dist [Cache] Implement PSR-16 SimpleCache v1.0 2017-01-23 14:57:50 +01:00

README.md

README

What is Symfony?

Symfony is a PHP full-stack web framework. It is written with speed and flexibility in mind. It allows developers to build better and easy to maintain websites with PHP.

Symfony can be used to develop all kind of websites, from your personal blog to high traffic ones like Dailymotion or Yahoo! Answers.

Installation

The best way to install Symfony is to use the official Symfony Installer. It allows you to start a new project based on the version you want.

Documentation

The "Quick Tour" tutorial gives you a first feeling of the framework. If, like us, you think that Symfony can help speed up your development and take the quality of your work to the next level, read the official Symfony documentation.

Contributing

Symfony is an open source, community-driven project. If you'd like to contribute, please read the Contributing Code part of the documentation. If you're submitting a pull request, please follow the guidelines in the Submitting a Patch section and use Pull Request Template.

Community Reviews

If you don't feel ready to contribute code or patches, reviewing issues and pull requests can be a great start to get involved and give back. In fact, people who "triage" issues are the backbone to Symfony's success!
More information can be found in the Community Reviews guide.

Running Symfony Tests

Information on how to run the Symfony test suite can be found in the Running Symfony Tests section.