Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve usage documentation #58

Closed
Glavin001 opened this issue Aug 8, 2014 · 6 comments
Closed

Improve usage documentation #58

Glavin001 opened this issue Aug 8, 2014 · 6 comments
Assignees
@Glavin001
Labels
enhancement high priority
Milestone
v0.28.0

Comments

@Glavin001
Copy link
Owner

Each language should have detailed installation and usage customization instructions.
@Glavin001 Glavin001 self-assigned this Aug 8, 2014
@Glavin001 Glavin001 mentioned this issue Aug 10, 2014
Closed
@Glavin001 Glavin001 added this to the v1.0.0 milestone Aug 13, 2014
@Glavin001 Glavin001 mentioned this issue Aug 13, 2014
Closed
@Glavin001
Copy link
Owner Author

  • What third-party beautifier is used per language
    • How to install these third-party beautifiers
  • Per language available configuration options

@m1ga
Copy link

m1ga commented Sep 20, 2014

You could add
"sudo pear install --alldeps channel://pear.php.net/php_beautifier-0.1.15"
to the PHP install instructions. Tested this on Fedora and its installing php_beautifier so you could use it with your package

This was referenced Sep 29, 2014
Closed
Closed
@minimit
Copy link

minimit commented Oct 15, 2014

Is it possible to install http://pear.php.net/package/PHP_Beautifier without installing pear, and php?
Btw this project is removed https://github.com/sdwood/php-beautifier

@Glavin001 Glavin001 mentioned this issue Jan 1, 2015
Closed
@Glavin001
Copy link
Owner Author

@minimit I have not yet found a way. I think we will be migrating off PHP_Beautifer and over to PHP Coding Standards Fixer ( #175 ).

@Glavin001
Copy link
Owner Author

  • Auto-generate package settings documentation from config (See Atom Config API). They now have descriptions!

@Glavin001 Glavin001 mentioned this issue Jan 8, 2015
Closed
@Glavin001 Glavin001 mentioned this issue Jan 26, 2015
Closed
@Glavin001 Glavin001 modified the milestones: v0.26.0, v0.25.0, v0.27.0, v0.28.0 May 3, 2015
Glavin001 added a commit that referenced this issue Jun 1, 2015
@Glavin001
See #58. Add automatic documentation generation for Options
9e90708 
npm run docs
Glavin001 added a commit that referenced this issue Jun 1, 2015
@Glavin001
See #58. Add package options to autogenerated documentation
5c663cd
@Glavin001
Copy link
Owner Author

Added auto-generated documentation for all options: https://github.com/Glavin001/atom-beautify/blob/master/docs/options.md

xiaofenqin pushed a commit to TheraPackages/atom-beautify that referenced this issue Jun 16, 2017
reduce Thera package size Glavin001#58
45ea90d
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Glavin001 Glavin001

Labels
enhancement high priority
Projects
None yet
Milestone
v0.28.0
Development

No branches or pull requests
3 participants
@minimit @Glavin001 @m1ga